{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:marketdata/v1-indices-candles-retrieve":{"get":{"operationId":"open_data_marketdata_v1_indices_candles_retrieve","summary":"Get historical price candles for an index.","description":"GET /v1/indices/candles/{resolution}/{symbol}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"resolution","in":"query","required":true,"description":"The duration of each candle. Minutely Resolutions: (1, 3, 5, 15, 30, 45, ...) Hourly Resolutions: (H, 1H, 2H, ...) Daily Resolutions: (D,…","schema":{"type":"string","description":"The duration of each candle. Minutely Resolutions: (1, 3, 5, 15, 30, 45, ...) Hourly Resolutions: (H, 1H, 2H, ...) Daily Resolutions: (D,…"}},{"name":"symbol","in":"query","required":true,"description":"The index's ticker symbol. If no exchange is specified. You may embed the exchange in the ticker symbol using the Yahoo Finance or…","schema":{"type":"string","description":"The index's ticker symbol. If no exchange is specified. You may embed the exchange in the ticker symbol using the Yahoo Finance or…"}},{"name":"date","in":"query","required":false,"description":"Use to lookup historical candles from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"Use to lookup historical candles from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet."}},{"name":"from","in":"query","required":false,"description":"The leftmost candle on a chart (inclusive). If you use countback, to is not required. Accepted timestamp inputs: ISO 8601, unix,…","schema":{"type":"string","description":"The leftmost candle on a chart (inclusive). If you use countback, to is not required. Accepted timestamp inputs: ISO 8601, unix,…"}},{"name":"to","in":"query","required":false,"description":"The rightmost candle on a chart (not inclusive). Accepted timestamp inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"The rightmost candle on a chart (not inclusive). Accepted timestamp inputs: ISO 8601, unix, spreadsheet."}},{"name":"countback","in":"query","required":false,"description":"Countback will fetch a number of candles before (to the left of) to If you use from, countback is not required.","schema":{"type":"integer","description":"Countback will fetch a number of candles before (to the left of) to If you use from, countback is not required."}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-indices-quotes-get":{"get":{"operationId":"open_data_marketdata_v1_indices_quotes_get","summary":"Get last quote for an index.","description":"GET /v1/indices/quotes/{symbol}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"symbol","in":"query","required":true,"description":"The index's ticker symbol. If no exchange is specified. You may embed the exchange in the ticker symbol using the Yahoo Finance or…","schema":{"type":"string","description":"The index's ticker symbol. If no exchange is specified. You may embed the exchange in the ticker symbol using the Yahoo Finance or…"}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-markets-status-retrieve":{"get":{"operationId":"open_data_marketdata_v1_markets_status_retrieve","summary":"Get market status (\"open\" or \"closed\") for a date or range of dates.","description":"GET /v1/markets/status","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"date","in":"query","required":false,"description":"Use to lookup status from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"Use to lookup status from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet."}},{"name":"from","in":"query","required":false,"description":"Limit the status to dates after from (inclusive). Should be combined with to to create a range. Accepted date inputs: ISO 8601, unix,…","schema":{"type":"string","description":"Limit the status to dates after from (inclusive). Should be combined with to to create a range. Accepted date inputs: ISO 8601, unix,…"}},{"name":"to","in":"query","required":false,"description":"Limit the status to dates before to (inclusive). Should be combined with from to create a range. Accepted date inputs: ISO 8601, unix,…","schema":{"type":"string","description":"Limit the status to dates before to (inclusive). Should be combined with from to create a range. Accepted date inputs: ISO 8601, unix,…"}},{"name":"countback","in":"query","required":false,"description":"Countback will fetch a number of dates before (to the left of) to. If you use from, countback is not required.","schema":{"type":"integer","description":"Countback will fetch a number of dates before (to the left of) to. If you use from, countback is not required."}},{"name":"country","in":"query","required":false,"description":"Use to specify the country of the exchange. Use the two digit ISO 3166 country code. If no country is specified, US exchanges will be…","schema":{"type":"string","description":"Use to specify the country of the exchange. Use the two digit ISO 3166 country code. If no country is specified, US exchanges will be…"}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-options-chain-retrieve":{"get":{"operationId":"open_data_marketdata_v1_options_chain_retrieve","summary":"Get a current or historical end of day options chain for an underlying ticker symbol. Optional parameters…","description":"GET /v1/options/chain/{underlying}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"underlying","in":"query","required":true,"description":"The underlying ticker symbol for the options chain you wish to lookup. Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)","schema":{"type":"string","description":"The underlying ticker symbol for the options chain you wish to lookup. Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)"}},{"name":"date","in":"query","required":false,"description":"Use to lookup a historical end of day options chain from a specific trading day. If no date is specified the chain will be the most…","schema":{"type":"string","description":"Use to lookup a historical end of day options chain from a specific trading day. If no date is specified the chain will be the most…"}},{"name":"expiration","in":"query","required":false,"description":"Limit the option chain to a specific expiration date. Accepted date inputs: ISO 8601, unix, spreadsheet. If omitted all expirations will…","schema":{"type":"string","description":"Limit the option chain to a specific expiration date. Accepted date inputs: ISO 8601, unix, spreadsheet. If omitted all expirations will…"}},{"name":"from","in":"query","required":false,"description":"Limit the option chain to expiration dates after from (inclusive). Should be combined with to to create a range. Accepted date inputs: ISO…","schema":{"type":"string","description":"Limit the option chain to expiration dates after from (inclusive). Should be combined with to to create a range. Accepted date inputs: ISO…"}},{"name":"to","in":"query","required":false,"description":"Limit the option chain to expiration dates before to (not inclusive). Should be combined with from to create a range. Accepted date…","schema":{"type":"string","description":"Limit the option chain to expiration dates before to (not inclusive). Should be combined with from to create a range. Accepted date…"}},{"name":"month","in":"query","required":false,"description":"Limit the option chain to options that expire in a specific month (1-12).","schema":{"type":"integer","description":"Limit the option chain to options that expire in a specific month (1-12)."}},{"name":"year","in":"query","required":false,"description":"Limit the option chain to options that expire in a specific year.","schema":{"type":"integer","description":"Limit the option chain to options that expire in a specific year."}},{"name":"weekly","in":"query","required":false,"description":"Limit the option chain to weekly expirations by setting weekly to true and omitting the monthly and quarterly parameters. If set to false,…","schema":{"type":"boolean","description":"Limit the option chain to weekly expirations by setting weekly to true and omitting the monthly and quarterly parameters. If set to false,…"}},{"name":"monthly","in":"query","required":false,"description":"Limit the option chain to standard monthly expirations by setting monthly to true and omitting the weekly and quarterly parameters. If set…","schema":{"type":"boolean","description":"Limit the option chain to standard monthly expirations by setting monthly to true and omitting the weekly and quarterly parameters. If set…"}},{"name":"quarterly","in":"query","required":false,"description":"Limit the option chain to quarterly expirations by setting quarterly to true and omitting the weekly and monthly parameters. If set to…","schema":{"type":"boolean","description":"Limit the option chain to quarterly expirations by setting quarterly to true and omitting the weekly and monthly parameters. If set to…"}},{"name":"dte","in":"query","required":false,"description":"Days to expiry. Limit the option chain to a single expiration date closest to the dte provided. Should not be used together with from and…","schema":{"type":"integer","description":"Days to expiry. Limit the option chain to a single expiration date closest to the dte provided. Should not be used together with from and…"}},{"name":"side","in":"query","required":false,"description":"Limit the option chain to either call or put. If omitted, both sides will be returned.","schema":{"type":"string","enum":["call","put"],"description":"Limit the option chain to either call or put. If omitted, both sides will be returned."}},{"name":"range","in":"query","required":false,"description":"Limit the option chain to strikes that are in the money, out of the money, or include all. If omitted all options will be returned. Valid…","schema":{"type":"string","enum":["all","itm","otm"],"description":"Limit the option chain to strikes that are in the money, out of the money, or include all. If omitted all options will be returned. Valid…"}},{"name":"strike","in":"query","required":false,"description":"Limit the option chain to options with the specific strike specified.","schema":{"type":"number","description":"Limit the option chain to options with the specific strike specified."}},{"name":"minOpenInterest","in":"query","required":false,"description":"Limit the option chain to options with an open interest greater than or equal to the number provided. Can be combined with minVolume and…","schema":{"type":"number","description":"Limit the option chain to options with an open interest greater than or equal to the number provided. Can be combined with minVolume and…"}},{"name":"minVolume","in":"query","required":false,"description":"Limit the option chain to options with an volume transacted greater than or equal to the number provided.","schema":{"type":"integer","description":"Limit the option chain to options with an volume transacted greater than or equal to the number provided."}},{"name":"maxBidAskSpread","in":"query","required":false,"description":"Limit the option chain to options with a bid-ask spread less than or equal to the number provided.","schema":{"type":"number","description":"Limit the option chain to options with a bid-ask spread less than or equal to the number provided."}},{"name":"maxBidAskSpreadPct","in":"query","required":false,"description":"Limit the option chain to options with a bid-ask spread less than or equal to the percent provided (relative to the underlying). For…","schema":{"type":"number","description":"Limit the option chain to options with a bid-ask spread less than or equal to the percent provided (relative to the underlying). For…"}},{"name":"nonstandard","in":"query","required":false,"description":"Include non-standard contracts by nonstandard to true. If set to false, no non-standard options expirations will be returned. If no…","schema":{"type":"boolean","description":"Include non-standard contracts by nonstandard to true. If set to false, no non-standard options expirations will be returned. If no…"}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"symbol_lookup","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"quote","in":"query","required":false,"description":"Include quotes","schema":{"type":"boolean","description":"Include quotes"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-options-expirations-list":{"get":{"operationId":"open_data_marketdata_v1_options_expirations_list","summary":"Get a list of current or historical option expiration dates for an underlying symbol. If no optional…","description":"GET /v1/options/expirations/{underlying}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"underlying","in":"query","required":true,"description":"The underlying ticker symbol for the options chain you wish to lookup. Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)","schema":{"type":"string","description":"The underlying ticker symbol for the options chain you wish to lookup. Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)"}},{"name":"strike","in":"query","required":false,"description":"Limit the lookup of expiration dates to the strike provide. This will cause the endpoint to only return expiration dates that include this…","schema":{"type":"number","description":"Limit the lookup of expiration dates to the strike provide. This will cause the endpoint to only return expiration dates that include this…"}},{"name":"date","in":"query","required":false,"description":"Use to lookup a historical list of expiration dates from a specific previous trading day. If date is omitted the expiration dates will be…","schema":{"type":"string","description":"Use to lookup a historical list of expiration dates from a specific previous trading day. If date is omitted the expiration dates will be…"}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"symbol_lookup","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-options-symbol-get":{"get":{"operationId":"open_data_marketdata_v1_options_symbol_get","summary":"Generate a properly formatted OCC option symbol based on the user's human-readable description of an option.…","description":"GET /v1/options/lookup/{userInput}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["csv","json"]}},{"name":"userInput","in":"query","required":true,"description":"The human-readable string input that contains (1) stock symbol (2) strike (3) expiration date (4) option side (i.e. put or call). This…","schema":{"type":"string","description":"The human-readable string input that contains (1) stock symbol (2) strike (3) expiration date (4) option side (i.e. put or call). This…"}}],"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/open-data:marketdata/v1-options-quotes-retrieve":{"get":{"operationId":"open_data_marketdata_v1_options_quotes_retrieve","summary":"Get a current or historical end of day quote for a single or multiple options contracts. Separate multiple…","description":"GET /v1/options/quotes/{optionSymbol}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"optionSymbol","in":"query","required":true,"description":"The option symbol (as defined by the OCC) for the option you wish to lookup. Use the current OCC option symbol format, even for historic…","schema":{"type":"string","description":"The option symbol (as defined by the OCC) for the option you wish to lookup. Use the current OCC option symbol format, even for historic…"}},{"name":"date","in":"query","required":false,"description":"Use to lookup a historical end of day quote from a specific trading day. If no date is specified the quote will be the most current price…","schema":{"type":"string","description":"Use to lookup a historical end of day quote from a specific trading day. If no date is specified the quote will be the most current price…"}},{"name":"from","in":"query","required":false,"description":"Use to lookup a series of end of day quotes. From is the oldest (leftmost) date to return (inclusive). If from/to is not specified the…","schema":{"type":"string","description":"Use to lookup a series of end of day quotes. From is the oldest (leftmost) date to return (inclusive). If from/to is not specified the…"}},{"name":"to","in":"query","required":false,"description":"Use to lookup a series of end of day quotes. To is the newest (rightmost) date to return (exclusive). If from/to is not specified the…","schema":{"type":"string","description":"Use to lookup a series of end of day quotes. To is the newest (rightmost) date to return (exclusive). If from/to is not specified the…"}},{"name":"countback","in":"query","required":false,"description":"Countback will fetch a number of quotes before (to the left of) to If you use from, countback is not required.","schema":{"type":"integer","description":"Countback will fetch a number of quotes before (to the left of) to If you use from, countback is not required."}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-options-strikes-get":{"get":{"operationId":"open_data_marketdata_v1_options_strikes_get","summary":"Get a list of current or historical options strikes for an underlying symbol. If no optional parameters are…","description":"GET /v1/options/strikes/{underlying}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"underlying","in":"query","required":true,"description":"The underlying ticker symbol for the options chain you wish to lookup. Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)","schema":{"type":"string","description":"The underlying ticker symbol for the options chain you wish to lookup. Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)"}},{"name":"date","in":"query","required":false,"description":"Use to lookup a historical list of strikes from a specific previous trading day. If date is omitted the strikes will be from the current…","schema":{"type":"string","description":"Use to lookup a historical list of strikes from a specific previous trading day. If date is omitted the strikes will be from the current…"}},{"name":"expiration","in":"query","required":false,"description":"imit the lookup of strikes to options that expire on a specific expiration date. Accepted date inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"imit the lookup of strikes to options that expire on a specific expiration date. Accepted date inputs: ISO 8601, unix, spreadsheet."}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"symbol_lookup","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-stocks-bulkcandles-get":{"get":{"operationId":"open_data_marketdata_v1_stocks_bulkcandles_get","summary":"Get bulk candle data for stocks. This endpoint returns bulk daily candle data for multiple stocks.","description":"GET /v1/stocks/bulkcandles/{resolution}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"resolution","in":"query","required":true,"description":"The duration of each candle. Minutely Resolutions: (1, 3, 5, 15, 30, 45, ...) Hourly Resolutions: (H, 1H, 2H, ...) Daily Resolutions: (D,…","schema":{"type":"string","description":"The duration of each candle. Minutely Resolutions: (1, 3, 5, 15, 30, 45, ...) Hourly Resolutions: (H, 1H, 2H, ...) Daily Resolutions: (D,…"}},{"name":"symbol","in":"query","required":true,"description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…","schema":{"type":"string","description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…"}},{"name":"date","in":"query","required":false,"description":"Use to lookup historical candles from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"Use to lookup historical candles from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet."}},{"name":"from","in":"query","required":false,"description":"The leftmost candle on a chart (inclusive). If you use countback, to is not required. Accepted timestamp inputs: ISO 8601, unix,…","schema":{"type":"string","description":"The leftmost candle on a chart (inclusive). If you use countback, to is not required. Accepted timestamp inputs: ISO 8601, unix,…"}},{"name":"to","in":"query","required":false,"description":"The rightmost candle on a chart (not inclusive). Accepted timestamp inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"The rightmost candle on a chart (not inclusive). Accepted timestamp inputs: ISO 8601, unix, spreadsheet."}},{"name":"countback","in":"query","required":false,"description":"Countback will fetch a number of candles before (to the left of) to If you use from, countback is not required.","schema":{"type":"integer","description":"Countback will fetch a number of candles before (to the left of) to If you use from, countback is not required."}},{"name":"exchange","in":"query","required":false,"description":"Use to specify the exchange of the ticker. This is useful when you need to specify stock that quotes on several exchanges with the same…","schema":{"type":"string","description":"Use to specify the exchange of the ticker. This is useful when you need to specify stock that quotes on several exchanges with the same…"}},{"name":"extended","in":"query","required":false,"description":"Include extended hours trading sessions when returning intraday candles. Daily resolutions never return extended hours candles. The…","schema":{"type":"boolean","description":"Include extended hours trading sessions when returning intraday candles. Daily resolutions never return extended hours candles. The…"}},{"name":"country","in":"query","required":false,"description":"Use to specify the country of the exchange (not the country of the company) in conjunction with the symbol argument. This argument is…","schema":{"type":"string","description":"Use to specify the country of the exchange (not the country of the company) in conjunction with the symbol argument. This argument is…"}},{"name":"adjustsplits","in":"query","required":false,"description":"Adjust historical data for for historical splits and reverse splits. Market Data uses the CRSP methodology for adjustment. Daily candles…","schema":{"type":"boolean","description":"Adjust historical data for for historical splits and reverse splits. Market Data uses the CRSP methodology for adjustment. Daily candles…"}},{"name":"adjustdividends","in":"query","required":false,"description":"Adjust candles for dividends. Market Data uses the CRSP methodology for adjustment. Daily candles default: true. Intraday candles default:…","schema":{"type":"boolean","description":"Adjust candles for dividends. Market Data uses the CRSP methodology for adjustment. Daily candles default: true. Intraday candles default:…"}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-stocks-bulkquotes-list":{"get":{"operationId":"open_data_marketdata_v1_stocks_bulkquotes_list","summary":"Get bulk quote data for stocks. This endpoint returns bulk real time quote data for multiple stocks.","description":"GET /v1/stocks/bulkquotes","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"symbol","in":"query","required":true,"description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…","schema":{"type":"string","description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…"}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"symbol_lookup","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-stocks-candles-retrieve":{"get":{"operationId":"open_data_marketdata_v1_stocks_candles_retrieve","summary":"Get historical price candles for a stock.","description":"GET /v1/stocks/candles/{resolution}/{symbol}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"resolution","in":"query","required":true,"description":"The duration of each candle. Minutely Resolutions: (1, 3, 5, 15, 30, 45, ...) Hourly Resolutions: (H, 1H, 2H, ...) Daily Resolutions: (D,…","schema":{"type":"string","description":"The duration of each candle. Minutely Resolutions: (1, 3, 5, 15, 30, 45, ...) Hourly Resolutions: (H, 1H, 2H, ...) Daily Resolutions: (D,…"}},{"name":"symbol","in":"query","required":true,"description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…","schema":{"type":"string","description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…"}},{"name":"date","in":"query","required":false,"description":"Use to lookup historical candles from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"Use to lookup historical candles from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet."}},{"name":"from","in":"query","required":false,"description":"The leftmost candle on a chart (inclusive). If you use countback, to is not required. Accepted timestamp inputs: ISO 8601, unix,…","schema":{"type":"string","description":"The leftmost candle on a chart (inclusive). If you use countback, to is not required. Accepted timestamp inputs: ISO 8601, unix,…"}},{"name":"to","in":"query","required":false,"description":"The rightmost candle on a chart (not inclusive). Accepted timestamp inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"The rightmost candle on a chart (not inclusive). Accepted timestamp inputs: ISO 8601, unix, spreadsheet."}},{"name":"countback","in":"query","required":false,"description":"Countback will fetch a number of candles before (to the left of) to If you use from, countback is not required.","schema":{"type":"integer","description":"Countback will fetch a number of candles before (to the left of) to If you use from, countback is not required."}},{"name":"exchange","in":"query","required":false,"description":"Use to specify the exchange of the ticker. This is useful when you need to specify stock that quotes on several exchanges with the same…","schema":{"type":"string","description":"Use to specify the exchange of the ticker. This is useful when you need to specify stock that quotes on several exchanges with the same…"}},{"name":"extended","in":"query","required":false,"description":"Include extended hours trading sessions when returning intraday candles. Daily resolutions never return extended hours candles. The…","schema":{"type":"boolean","description":"Include extended hours trading sessions when returning intraday candles. Daily resolutions never return extended hours candles. The…"}},{"name":"country","in":"query","required":false,"description":"Use to specify the country of the exchange (not the country of the company) in conjunction with the symbol argument. This argument is…","schema":{"type":"string","description":"Use to specify the country of the exchange (not the country of the company) in conjunction with the symbol argument. This argument is…"}},{"name":"adjustsplits","in":"query","required":false,"description":"Adjust historical data for for historical splits and reverse splits. Market Data uses the CRSP methodology for adjustment. Daily candles…","schema":{"type":"boolean","description":"Adjust historical data for for historical splits and reverse splits. Market Data uses the CRSP methodology for adjustment. Daily candles…"}},{"name":"adjustdividends","in":"query","required":false,"description":"Adjust candles for dividends. Market Data uses the CRSP methodology for adjustment. Daily candles default: true. Intraday candles default:…","schema":{"type":"boolean","description":"Adjust candles for dividends. Market Data uses the CRSP methodology for adjustment. Daily candles default: true. Intraday candles default:…"}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint’s default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-stocks-earnings-symbol-get":{"get":{"operationId":"open_data_marketdata_v1_stocks_earnings_symbol_get","summary":"Get historical earnings per share data or a future earnings calendar for a stock.","description":"GET /v1/stocks/earnings/{symbol}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"symbol","in":"query","required":true,"description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…","schema":{"type":"string","description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…"}},{"name":"date","in":"query","required":false,"description":"Retrieve a specific earnings report by date. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"Retrieve a specific earnings report by date. Accepted timestamp inputs: ISO 8601, unix, spreadsheet."}},{"name":"from","in":"query","required":false,"description":"The earliest earnings report to include in the output.If you use countback, from is not required. Accepted timestamp inputs: ISO 8601,…","schema":{"type":"string","description":"The earliest earnings report to include in the output.If you use countback, from is not required. Accepted timestamp inputs: ISO 8601,…"}},{"name":"to","in":"query","required":false,"description":"The latest earnings report to include in the output. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"The latest earnings report to include in the output. Accepted timestamp inputs: ISO 8601, unix, spreadsheet."}},{"name":"countback","in":"query","required":false,"description":"Countback will fetch a specific number of earnings reports before to. If you use from, countback is not required.","schema":{"type":"integer","description":"Countback will fetch a specific number of earnings reports before to. If you use from, countback is not required."}},{"name":"report","in":"query","required":false,"description":"Retrieve a specific earnings report by date and quarter. Example: 2023-Q4. This allows you to retrieve a 4th qurater value without knowing…","schema":{"type":"string","description":"Retrieve a specific earnings report by date and quarter. Example: 2023-Q4. This allows you to retrieve a 4th qurater value without knowing…"}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-stocks-news-retrieve":{"get":{"operationId":"open_data_marketdata_v1_stocks_news_retrieve","summary":"Get news for a stock.","description":"GET /v1/stocks/news/{symbol}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"symbol","in":"query","required":true,"description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…","schema":{"type":"string","description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…"}},{"name":"date","in":"query","required":false,"description":"Retrieve a specific earnings report by date. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"Retrieve a specific earnings report by date. Accepted timestamp inputs: ISO 8601, unix, spreadsheet."}},{"name":"from","in":"query","required":false,"description":"The earliest earnings report to include in the output.If you use countback, from is not required. Accepted timestamp inputs: ISO 8601,…","schema":{"type":"string","description":"The earliest earnings report to include in the output.If you use countback, from is not required. Accepted timestamp inputs: ISO 8601,…"}},{"name":"to","in":"query","required":false,"description":"The latest earnings report to include in the output. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.","schema":{"type":"string","description":"The latest earnings report to include in the output. Accepted timestamp inputs: ISO 8601, unix, spreadsheet."}},{"name":"countback","in":"query","required":false,"description":"Countback will fetch a specific number of earnings reports before to. If you use from, countback is not required.","schema":{"type":"integer","description":"Countback will fetch a specific number of earnings reports before to. If you use from, countback is not required."}},{"name":"report","in":"query","required":false,"description":"Retrieve a specific earnings report by date and quarter. Example: 2023-Q4. This allows you to retrieve a 4th qurater value without knowing…","schema":{"type":"string","description":"Retrieve a specific earnings report by date and quarter. Example: 2023-Q4. This allows you to retrieve a 4th qurater value without knowing…"}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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/open-data:marketdata/v1-stocks-last-quote-get":{"get":{"operationId":"open_data_marketdata_v1_stocks_last_quote_get","summary":"Get last quote for a stock.","description":"GET /v1/stocks/quotes/{symbol}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.","schema":{"type":"string","enum":["csv","json"],"description":"The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON."}},{"name":"symbol","in":"query","required":true,"description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…","schema":{"type":"string","description":"The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the…"}},{"name":"dateformat","in":"query","required":false,"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in.","schema":{"type":"string","enum":["spreadsheet","timestamp","unix"],"description":"The dateformat parameter allows you specify the format you wish to receive date and time information in."}},{"name":"limit","in":"query","required":false,"description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get…","schema":{"type":"integer","description":"The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get…"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…","schema":{"type":"integer","description":"The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return…"}},{"name":"headers","in":"query","required":false,"description":"The headers parameter is used to turn off headers when using CSV output.","schema":{"type":"boolean","description":"The headers parameter is used to turn off headers when using CSV output."}},{"name":"columns","in":"query","required":false,"description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…","schema":{"type":"string","description":"The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed…"}},{"name":"symbol_lookup","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"human","in":"query","required":false,"description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.","schema":{"type":"boolean","description":"Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names."}}],"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":"dev-tools:hash"},"data":{},"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"}}}}}}}