{"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/finance:polygon/get-v1-companies":{"get":{"operationId":"finance_polygon_get_v1_companies","summary":"Available Companies","description":"GET /v1/companies","tags":["finance"],"x-apizie-access":"read","parameters":[{"name":"sort","in":"query","required":false,"description":"Which field to sort by. For desc place a `-` in front of the field name. eg `?sort=-marketcap`","schema":{"type":"string","description":"Which field to sort by. For desc place a `-` in front of the field name. eg `?sort=-marketcap`"}},{"name":"perpage","in":"query","required":false,"description":"How many items to be on each page during pagination","schema":{"type":"number","description":"How many items to be on each page during pagination"}},{"name":"page","in":"query","required":false,"description":"Which page of results to return","schema":{"type":"number","default":1,"description":"Which page of results to return"}}],"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/finance:polygon/get-v1-currencies":{"get":{"operationId":"finance_polygon_get_v1_currencies","summary":"Available Currencies","description":"GET /v1/currencies","tags":["finance"],"x-apizie-access":"read","parameters":[],"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/finance:polygon/get-v1-historic-agg-size-symbol-date":{"get":{"operationId":"finance_polygon_get_v1_historic_agg_size_symbol_date","summary":"Historic Aggregates","description":"GET /v1/historic/agg/{size}/{symbol}/{date}","tags":["finance"],"x-apizie-access":"read","parameters":[{"name":"size","in":"query","required":true,"description":"Size of the aggregation. `second` or `minute`","schema":{"type":"string","enum":["second","minute"],"description":"Size of the aggregation. `second` or `minute`"}},{"name":"symbol","in":"query","required":true,"description":"Symbol of the company to retrieve","schema":{"type":"string","description":"Symbol of the company to retrieve"}},{"name":"date","in":"query","required":true,"description":"Date/Day of the historic ticks to retreive","schema":{"type":"string","description":"Date/Day of the historic ticks to retreive"}},{"name":"offset","in":"query","required":false,"description":"Timestamp offset, used for pagination","schema":{"type":"integer","description":"Timestamp offset, used for pagination"}},{"name":"limit","in":"query","required":false,"description":"Limit the size of response, max: 10000","schema":{"type":"integer","default":100,"description":"Limit the size of response, max: 10000"}}],"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/finance:polygon/get-v1-historic-forex-from-to-date":{"get":{"operationId":"finance_polygon_get_v1_historic_forex_from_to_date","summary":"Historic Forex Ticks","description":"GET /v1/historic/forex/{from}/{to}/{date}","tags":["finance"],"x-apizie-access":"read","parameters":[{"name":"from","in":"query","required":true,"description":"From Symbol of the currency pair","schema":{"type":"string","description":"From Symbol of the currency pair"}},{"name":"to","in":"query","required":true,"description":"To Symbol of the currency pair","schema":{"type":"string","description":"To Symbol of the currency pair"}},{"name":"date","in":"query","required":true,"description":"Date/Day of the historic ticks to retreive","schema":{"type":"string","description":"Date/Day of the historic ticks to retreive"}},{"name":"offset","in":"query","required":false,"description":"Timestamp offset, used for pagination","schema":{"type":"integer","description":"Timestamp offset, used for pagination"}},{"name":"limit","in":"query","required":false,"description":"Limit the size of response, max: 10000","schema":{"type":"integer","default":100,"description":"Limit the size of response, max: 10000"}}],"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/finance:polygon/get-v1-historic-quotes-symbol-date":{"get":{"operationId":"finance_polygon_get_v1_historic_quotes_symbol_date","summary":"Historic Quotes","description":"GET /v1/historic/quotes/{symbol}/{date}","tags":["finance"],"x-apizie-access":"read","parameters":[{"name":"symbol","in":"query","required":true,"description":"Symbol of the company to retrieve","schema":{"type":"string","description":"Symbol of the company to retrieve"}},{"name":"date","in":"query","required":true,"description":"Date/Day of the historic ticks to retreive","schema":{"type":"string","description":"Date/Day of the historic ticks to retreive"}},{"name":"offset","in":"query","required":false,"description":"Timestamp offset, used for pagination","schema":{"type":"integer","description":"Timestamp offset, used for pagination"}},{"name":"limit","in":"query","required":false,"description":"Limit the size of response, max: 10000","schema":{"type":"integer","default":100,"description":"Limit the size of response, max: 10000"}}],"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/finance:polygon/get-v1-historic-trades-symbol-date":{"get":{"operationId":"finance_polygon_get_v1_historic_trades_symbol_date","summary":"Historic Trades","description":"GET /v1/historic/trades/{symbol}/{date}","tags":["finance"],"x-apizie-access":"read","parameters":[{"name":"symbol","in":"query","required":true,"description":"Symbol of the company to retrieve","schema":{"type":"string","description":"Symbol of the company to retrieve"}},{"name":"date","in":"query","required":true,"description":"Date/Day of the historic ticks to retreive","schema":{"type":"string","description":"Date/Day of the historic ticks to retreive"}},{"name":"offset","in":"query","required":false,"description":"Timestamp offset, used for pagination","schema":{"type":"integer","description":"Timestamp offset, used for pagination"}},{"name":"limit","in":"query","required":false,"description":"Limit the size of response, max: 10000","schema":{"type":"integer","default":100,"description":"Limit the size of response, max: 10000"}}],"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/finance:polygon/get-v1-last-currencies-from-to":{"get":{"operationId":"finance_polygon_get_v1_last_currencies_from_to","summary":"Last Trade for a Currency Pair","description":"GET /v1/last/currencies/{from}/{to}","tags":["finance"],"x-apizie-access":"read","parameters":[{"name":"from","in":"query","required":true,"description":"From Symbol of the pair","schema":{"type":"string","description":"From Symbol of the pair"}},{"name":"to","in":"query","required":true,"description":"To Symbol of the pair","schema":{"type":"string","description":"To Symbol of the pair"}}],"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/finance:polygon/get-v1-last-stocks-symbol":{"get":{"operationId":"finance_polygon_get_v1_last_stocks_symbol","summary":"Last Trade for a Symbol","description":"GET /v1/last/stocks/{symbol}","tags":["finance"],"x-apizie-access":"read","parameters":[{"name":"symbol","in":"query","required":true,"description":"Symbol of the stock to get","schema":{"type":"string","description":"Symbol of the stock to get"}}],"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/finance:polygon/get-v1-last-quote-currencies-from-to":{"get":{"operationId":"finance_polygon_get_v1_last_quote_currencies_from_to","summary":"Last Quote for a Currency Pair","description":"GET /v1/last_quote/currencies/{from}/{to}","tags":["finance"],"x-apizie-access":"read","parameters":[{"name":"from","in":"query","required":true,"description":"From Symbol of the pair","schema":{"type":"string","description":"From Symbol of the pair"}},{"name":"to","in":"query","required":true,"description":"To Symbol of the pair","schema":{"type":"string","description":"To Symbol of the pair"}}],"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/finance:polygon/get-v1-last-quote-stocks-symbol":{"get":{"operationId":"finance_polygon_get_v1_last_quote_stocks_symbol","summary":"Last Quote for a Symbol","description":"GET /v1/last_quote/stocks/{symbol}","tags":["finance"],"x-apizie-access":"read","parameters":[{"name":"symbol","in":"query","required":true,"description":"Symbol of the stock to get","schema":{"type":"string","description":"Symbol of the stock to get"}}],"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"}}}}}}}