{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:zeit/get-webhooks":{"get":{"operationId":"cloud_zeit_get_webhooks","summary":"Get a list of existent webhooks","description":"GET /v1/integrations/webhooks","tags":["cloud"],"x-apizie-access":"read","parameters":[{"name":"teamId","in":"query","required":false,"description":"A team id in case you want to act on behalf of a team","schema":{"type":"string","description":"A team id in case you want to act on behalf of a team"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:zeit/create-webhook":{"post":{"operationId":"cloud_zeit_create_webhook","summary":"Create a new webhook","description":"POST /v1/integrations/webhooks","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"teamId":{"type":"string","description":"A team id in case you want to act on behalf of a team"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:zeit/delete-webhooks":{"post":{"operationId":"cloud_zeit_delete_webhooks","summary":"Remove a webhook by id","description":"DELETE /v1/integrations/webhooks/:id","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"teamId":{"type":"string","description":"A team id in case you want to act on behalf of a team"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:zeit/get-domains":{"get":{"operationId":"cloud_zeit_get_domains","summary":"Gets a list of domains registered for the authenticating user.","description":"GET /v4/domains","tags":["cloud"],"x-apizie-access":"read","parameters":[{"name":"teamId","in":"query","required":false,"description":"A team id in case you want to act on behalf of a team","schema":{"type":"string","description":"A team id in case you want to act on behalf of a team"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:zeit/get-domain":{"get":{"operationId":"cloud_zeit_get_domain","summary":"Get a domain for the authenticated user by name","description":"GET /v4/domains/{name}","tags":["cloud"],"x-apizie-access":"read","parameters":[{"name":"name","in":"query","required":true,"description":"A team id in case you want to act on behalf of a team","schema":{"type":"string","description":"A team id in case you want to act on behalf of a team"}},{"name":"teamId","in":"query","required":false,"description":"A team id in case you want to act on behalf of a team","schema":{"type":"string","description":"A team id in case you want to act on behalf of a team"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}