{ "info": { "name": "OHLC Market Data API", "description": "Query parameters take YYYY-MM-DD dates; responses carry UTC timestamps, explicit currencies, decimal strings and effective-dated MIC:TICKER symbols. Live coverage requires configured source metadata.\n\nSet the apiKey collection variable to your OHLC API key, then send any request. Each request enables one live example; the other parameters are listed but switched off.", "version": "2.0.0+b5463f5bbb43", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.ohlc.io", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" } ], "item": [ { "name": "Market prices", "item": [ { "name": "Quotes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/quotes?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "quotes" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Comma-separated MIC:TICKER symbols (crypto pairs are CRYPTO:BTC-USD, currency pairs FOREX:EUR-USD, indices INDEX:GSPC, bonds BOND and the ISIN, such as BOND:US00037BAF94) or bare tickers, which resolve to the exchange listing that ticker; neither part is case-sensitive, and two spellings of one listing count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. At most 100, further limited by the effective plan and key scope. A symbol names the listing recorded under it at symbol_at; at a date before any ticker is recorded for a listing, the earliest ticker recorded for it selects it as well (see symbol_at). Supply symbols or instrument_ids." }, { "key": "instrument_ids", "value": "", "description": "Comma-separated stable instrument IDs (the instrument_id of each row, and of the research endpoints) instead of symbols; each selects its listing at any date, including history from before its earliest recorded ticker and listings that no longer trade. Rows carry the symbol the listing had at symbol_at, or where it had none then, its symbol at as_of, else the last one it carried by as_of, else its first. At most 100. Cannot be combined with symbols.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. A ticker names the listing that carries it at symbol_at, and every row of a from/to range carries that symbol, rows from before the listing took the ticker included: a ticker reused after its earlier holder delisted returns the new holder's older rows, so set symbol_at inside the range to name the listing that traded under the ticker then. Tickers are recorded only where there is evidence for them (for many listings from 2003, though prices start earlier), and none is asserted earlier. As a lookup convenience, a date before a listing's earliest recorded ticker still finds the listing by that ticker when no record contradicts it (no listing is recorded under the ticker by that date, and the listing has no earlier ticker): its rows carry the symbol as a label and meta.unrecorded_symbols lists it. A date before the listing's first row returns 200 with no-data, as a to before it does. A ticker another listing held, or one the listing was renamed from or to, returns 404 naming the date and the listing; instrument_ids select a listing at any date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Latest delayed quote per symbol: the last trade of the newest snapshot, never real-time. Exchange listings are delayed at least 15 minutes. US listings are snapshotted every 10 minutes from 9:31 New York time until the delay has caught up with the close (about 16:30), so after the close last_price is the last trade in that final snapshot, after-hours prints included, and can differ from the official close; read the close from /v1/eod or /v1/snapshot (price_source session_close). Listings on the Toronto, TSX Venture, Cboe Canada, London, Euronext Paris and Amsterdam and ASX exchanges are quoted every 60 minutes while their exchange is open, from about 20 minutes after the open (on the ASX 20 minutes later, after its opening auction), and once more about 20 minutes after the close; in between, the listings requested from /v1/quotes, /v1/snapshot or the quote stream in the last 24 hours (up to 250 a market, the most recently requested) are quoted every 10 minutes, so their last_at is usually 20 to 35 minutes old while the exchange is open. Crypto quotes come around the clock from two sources that are not delayed: the leading pairs by market capitalization are quoted about every five minutes, so a pair's last_at is usually under 10 minutes old, and every other pair a source prices about every one to two hours. bid and ask fields are always null: no licensed source supplies quotes yet. Mutual funds (one NAV a day, in /v1/eod), bonds (the BOND venue, daily prices in /v1/eod) and OTC listings have no quotes; neither do preferreds listed on NYSE and NYSE American, which the delayed snapshot does not carry, and a crypto pair neither source prices has none. A request naming a mutual fund with a key whose plan lacks mutual-funds.read (Commercial and Scale include it) returns 403 mutual-funds-not-entitled. GET /v1/health lists, per exchange and asset type, how many listings have a quote (coverage.asset_types). A listing whose newest quote predates a session that has traded since is not served as current: it is reported in meta.errors as no-data, and /v1/snapshot and /v1/eod carry that session's close. A crypto pair's quote also gives way to a daily bar that closed after it, so a quote the source stopped updating is replaced by that UTC day's close. Currency pairs are quoted every ten minutes, without delay, for the majors and leading crosses only, while the forex market is open (Sunday 17:00 to Friday 17:30 New York time). Indices (the INDEX venue, such as INDEX:GSPC) are quoted every ten minutes, delayed about 15 minutes, for 38 leading indices only, while each one's home market is open; the other indices have daily bars only. Select listings with symbols or instrument_ids, not both. Requires quotes.read and an entitled market. An empty data array is a successful result. When none of the requested symbols resolves, the response is 404 symbol-not-resolved, whatever the size of the list; when at least one does, the others are reported in meta.errors." } }, { "name": "Daily bars", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/eod?symbols=XNAS:AAPL&from=2026-09-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "eod" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Comma-separated MIC:TICKER symbols (crypto pairs are CRYPTO:BTC-USD, currency pairs FOREX:EUR-USD, indices INDEX:GSPC, bonds BOND and the ISIN, such as BOND:US00037BAF94) or bare tickers, which resolve to the exchange listing that ticker; neither part is case-sensitive, and two spellings of one listing count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. At most 100, further limited by the effective plan and key scope. A symbol names the listing recorded under it at symbol_at; at a date before any ticker is recorded for a listing, the earliest ticker recorded for it selects it as well (see symbol_at). Supply symbols or instrument_ids, except with date, where omitting both selects every entitled listing." }, { "key": "instrument_ids", "value": "", "description": "Comma-separated stable instrument IDs (the instrument_id of each row, and of the research endpoints) instead of symbols; each selects its listing at any date, including history from before its earliest recorded ticker and listings that no longer trade. Rows carry the symbol the listing had at symbol_at, or where it had none then, its symbol at as_of, else the last one it carried by as_of, else its first. At most 100. Cannot be combined with symbols.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. With date it defaults to that date when earlier, so listings carry the symbols they traded under that day. A ticker names the listing that carries it at symbol_at, and every row of a from/to range carries that symbol, rows from before the listing took the ticker included: a ticker reused after its earlier holder delisted returns the new holder's older rows, so set symbol_at inside the range to name the listing that traded under the ticker then. Tickers are recorded only where there is evidence for them (for many listings from 2003, though prices start earlier), and none is asserted earlier. As a lookup convenience, a date before a listing's earliest recorded ticker still finds the listing by that ticker when no record contradicts it (no listing is recorded under the ticker by that date, and the listing has no earlier ticker): its rows carry the symbol as a label and meta.unrecorded_symbols lists it. A date before the listing's first row returns 200 with no-data, as a to before it does. A ticker another listing held, or one the listing was renamed from or to, returns 404 naming the date and the listing; instrument_ids select a listing at any date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "adjustment", "value": "", "description": "raw (default) serves prices and volume as traded. split restates bars before each later split to the current share basis: prices are multiplied by old over new shares, as the exact fraction, and rounded half up to 6 decimal places, and volume is multiplied by new over old shares and rounded half up to whole shares. total_return also multiplies prices by the dividend factors of later cash dividends, to the same 6 places. Adjusted bars carry adjustment and factor_set_version. Listings whose corporate actions are not collected (crypto and currency pairs, OTC) return 422 adjustment-unsupported for anything but raw, as do indices, whose levels already reflect their members' corporate actions, and bonds. Each mode needs its own validated factor set, else 503 adjustments-unavailable: split never waits on a dividend, while total_return is unavailable for a dividend it cannot value (one detaching on the day of a split, or not below that close) and, for rows before a dividend that just detached, until that close is in.", "disabled": true }, { "key": "date", "value": "", "description": "One exchange-local trading date (YYYY-MM-DD) instead of from and to: returns one bar per listing that traded that day, in symbol order. Without symbols or instrument_ids it covers every listing in the entitled markets. Raw prices only; cannot be combined with from, to or adjustment other than raw.", "disabled": true }, { "key": "exchanges", "value": "", "description": "Comma-separated ISO MIC codes, at most 100, that limit a whole-market date query; requires date without symbols or instrument_ids. Defaults to all entitled exchanges. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled.", "disabled": true }, { "key": "from", "value": "2026-09-01", "description": "First exchange-local trading date to include (YYYY-MM-DD)." }, { "key": "to", "value": "2026-09-25", "description": "Last exchange-local trading date to include (YYYY-MM-DD); on or after from, so from equal to to selects one session." }, { "key": "order", "value": "", "description": "Direction on date, or on the symbol in a date query, desc (default, newest first) or asc; a date query defaults to asc; ties keep their internal order in the same direction. The cursor is bound to it.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "End-of-day OHLCV bars, one per exchange-local trading date. Raw bars are as traded: prices are never restated for a later split, and share volume is whole shares. A US listing's latest session bar is published within minutes of the close from the consolidated tape and can be revised when the primary end-of-day source delivers the session later that evening or the next day: the bar then takes that source's prices, and keeps the consolidated tape's volume and trade count wherever the two agree on open, high, low and close; a bar that closes at least 90% away from the previous close is held until a split record or the next session confirms it. A listing on the Toronto, TSX Venture, Cboe Canada, London, Euronext Paris and Amsterdam or ASX exchanges has its session's bar published from the exchange's daily file about two hours after the close (asked for again hourly until the file carries the session), and the file is read again at 04:00 UTC the next day. A mutual fund has one bar a day, its net asset value; mutual funds need mutual-funds.read (Commercial and Scale): for other keys a request naming one returns 403 mutual-funds-not-entitled, and whole-market date queries leave them out. Most funds' history starts on 1 January 10 years before the current year; a short list of funds carries its full history. The leading crypto pairs' UTC day is published at about 00:10 UTC the next day from their last quotes of it, and every pair's from the provider's daily file at about 02:00 UTC, read again over the following week as the provider replaces the first bars it posts; a crypto bar's open is the previous day's close. A currency pair's UTC day is published at about 02:00 UTC the next day, Sunday's from the market's open that evening in New York; Saturday has no bar, and the bars carry no volume. History reaches back to 1971 for the majors. An index (the INDEX venue, such as INDEX:GSPC for the S&P 500) has a bar for each trading date of its home market, as its publisher calculates the level, with no volume; its instrument_id is the one /v1/indices gives it. Its bar is published at about 00:30 UTC after its trading date, whatever its market, since the venue's days are UTC days, and the leading indices are quoted during their sessions (/v1/quotes). History reaches back to 1927 for the S&P 500. A US corporate bond (the BOND venue, BOND: and its ISIN, such as BOND:US00037BAF94) has a bar for each US business day it traded, its clean price per 100 of face value, evaluated or last-trade, as open, high, low and close alike, with no volume: a bond that did not trade has no bar that day. A day's bars are published from about 08:00 UTC the next morning and again as the source adds prices during that morning; yields and terms are in /v1/bonds and /v1/bonds/yields. Default order: requested symbol, then date descending (newest first). With date instead of from and to, returns one bar per listing for that exchange-local trading date in symbol order: for every listing in the key's entitled markets (optionally limited by exchanges) when symbols and instrument_ids are omitted, like a daily market summary, or for the requested listings. A listing carries the symbol recorded for it on that date, or where none is recorded yet, the earliest symbol recorded for it (listed in meta.unrecorded_symbols). In a date query, order applies to the symbol, ascending by default, and prices are raw. Select listings with symbols or instrument_ids, not both; order=desc returns each listing's rows newest first (the default) and order=asc oldest first. Requires eod.read and an entitled market. An empty data array is a successful result. When none of the requested symbols resolves, the response is 404 symbol-not-resolved, whatever the size of the list; when at least one does, the others are reported in meta.errors." } }, { "name": "Intraday bars", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/intraday?symbols=XNAS:AAPL&interval=5m&session=regular", "host": [ "{{baseUrl}}" ], "path": [ "v1", "intraday" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Comma-separated MIC:TICKER symbols (crypto pairs are CRYPTO:BTC-USD, currency pairs FOREX:EUR-USD, indices INDEX:GSPC, bonds BOND and the ISIN, such as BOND:US00037BAF94) or bare tickers, which resolve to the exchange listing that ticker; neither part is case-sensitive, and two spellings of one listing count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. At most 100, further limited by the effective plan and key scope. A symbol names the listing recorded under it at symbol_at; at a date before any ticker is recorded for a listing, the earliest ticker recorded for it selects it as well (see symbol_at). Supply symbols or instrument_ids." }, { "key": "instrument_ids", "value": "", "description": "Comma-separated stable instrument IDs (the instrument_id of each row, and of the research endpoints) instead of symbols; each selects its listing at any date, including history from before its earliest recorded ticker and listings that no longer trade. Rows carry the symbol the listing had at symbol_at, or where it had none then, its symbol at as_of, else the last one it carried by as_of, else its first. At most 100. Cannot be combined with symbols.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. A ticker names the listing that carries it at symbol_at, and every row of a from/to range carries that symbol, rows from before the listing took the ticker included: a ticker reused after its earlier holder delisted returns the new holder's older rows, so set symbol_at inside the range to name the listing that traded under the ticker then. Tickers are recorded only where there is evidence for them (for many listings from 2003, though prices start earlier), and none is asserted earlier. As a lookup convenience, a date before a listing's earliest recorded ticker still finds the listing by that ticker when no record contradicts it (no listing is recorded under the ticker by that date, and the listing has no earlier ticker): its rows carry the symbol as a label and meta.unrecorded_symbols lists it. A date before the listing's first row returns 200 with no-data, as a to before it does. A ticker another listing held, or one the listing was renamed from or to, returns 404 naming the date and the listing; instrument_ids select a listing at any date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "adjustment", "value": "", "description": "raw (default) serves prices and volume as traded. split restates bars before each later split to the current share basis: prices are multiplied by old over new shares, as the exact fraction, and rounded half up to 6 decimal places, and volume is multiplied by new over old shares and rounded half up to whole shares. total_return also multiplies prices by the dividend factors of later cash dividends, to the same 6 places. Adjusted bars carry adjustment and factor_set_version. Listings whose corporate actions are not collected (crypto and currency pairs, OTC) return 422 adjustment-unsupported for anything but raw, as do indices, whose levels already reflect their members' corporate actions, and bonds. Each mode needs its own validated factor set, else 503 adjustments-unavailable: split never waits on a dividend, while total_return is unavailable for a dividend it cannot value (one detaching on the day of a split, or not below that close) and, for rows before a dividend that just detached, until that close is in.", "disabled": true }, { "key": "from", "value": "", "description": "First exchange-local trading date (YYYY-MM-DD) whose bars to include, from that exchange's midnight.", "disabled": true }, { "key": "to", "value": "", "description": "Last exchange-local trading date (YYYY-MM-DD) whose bars to include, through that exchange's midnight; on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on datetime, desc (default, newest first) or asc; ties keep their internal order in the same direction. The cursor is bound to it.", "disabled": true }, { "key": "interval", "value": "5m", "description": "Required, with session; a request without either returns 422 interval-required. Bar length. Exchange listings are collected as five-minute bars, so they serve 5m and 1h (rolled up from 5m); 1m is served only by listings collected at one minute, which today are crypto and currency pairs, and returns 422 unsupported-interval for the others." }, { "key": "session", "value": "regular", "description": "Required, with interval; a request without either returns 422 interval-required. regular selects the regular trading session, the only one collected for exchange listings: there are no pre-market or after-hours bars. all is every session of a continuous market: a crypto or currency pair trades in one session a UTC day, so it selects the same bars as regular there, and returns 422 unsupported-session for exchange listings." }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Intraday OHLCV bars of the regular session, kept for 30 days: older bars are deleted and there is no archive. A US listing's bars can be published during the session from a 15-minute-delayed minute-bar stream, each about 15 minutes after it closes, and are read again overnight from the end-of-day intraday source, which fills any the stream missed and decides where the two differ; other exchanges' bars are published overnight after the close. A listing whose bars the source posts late follows a session later; GET /v1/health reports per exchange how many listings have the newest closed session (coverage.latest_session) and turns partial or stale when they fall short 8 hours after the close. Crypto bars cover the leading pairs only, and each UTC day is read at 09:15 UTC the morning after it ends (again at 15:15 for a pair it left short), so the newest crypto bar is from the end of the previous UTC day, or of the day before that until about 09:30. They come from the provider's intraday feed, not the one behind the daily bars: their prices differ from the daily bar's by a fraction of a percent (0.1-0.2% measured in October 2026), so a day's minute high or low can fall outside its daily range, and their volume is in coins. The daily bar is the reference for a crypto pair's day. Currency pairs are collected at one minute for the majors and leading crosses only, each UTC day read at 03:20 UTC the morning after it ends; they carry no volume, and their bars match the daily bar. Indices, bonds and mutual funds have no intraday bars: a request for one returns no rows and names it in meta.errors as no-data. Exchange listings are collected as five-minute bars; 1h bars are rolled up from them on request, each session cut into hours from its open (for a US listing 9:30, 10:30, ..., 15:30 New York time, the last one shorter), with the first open, last close, extreme high and low and summed volume. Crypto and currency pairs serve the interval they are collected at and longer ones rolled up the same way. An interval a listing is not collected at returns 422 unsupported-interval rather than an empty page. Intraday bars do not sum to the daily bar of /v1/eod. The intraday source reports the regular session's five-minute bars from fewer trades than the consolidated daily bar counts: with all 78 bars of a session present, a liquid US stock's five-minute volumes added up to 66-77% of its daily volume over six sessions measured in 2026, and a daily open, high or low can lie outside the intraday range. Nothing outside the regular session is collected. Use /v1/eod for the session's official open, high, low, close and volume. Default order: requested symbol, then datetime descending (newest first). Select listings with symbols or instrument_ids, not both; order=desc returns each listing's rows newest first (the default) and order=asc oldest first. Requires intraday.read and an entitled market. An empty data array is a successful result. When none of the requested symbols resolves, the response is 404 symbol-not-resolved, whatever the size of the list; when at least one does, the others are reported in meta.errors." } }, { "name": "Snapshot", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/snapshot?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "snapshot" ], "query": [ { "key": "symbols", "value": "XNAS:AAPL", "description": "Comma-separated MIC:TICKER symbols (crypto pairs are CRYPTO:BTC-USD, currency pairs FOREX:EUR-USD, indices INDEX:GSPC, bonds BOND and the ISIN, such as BOND:US00037BAF94) or bare tickers, which resolve to the exchange listing that ticker, or else to the listing a common vendor spelling names (RY.TO, SHEL.L, BHP.AX, ^GSPC, EURUSD=X); at most 100, further limited by the effective plan and key scope." }, { "key": "instrument_ids", "value": "", "description": "Comma-separated stable instrument IDs; cannot be combined with symbols.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "One row per requested listing: the latest eligible quote, the latest and previous session daily bars, and the change of the latest price from the previous close. Quotes are snapshots, never real-time: delayed at least 15 minutes for exchange listings and about 15 minutes for indices, and up to about 10 minutes old for the leading crypto pairs and for currency pairs while the forex market is open (a crypto quote older than the close of the pair's latest daily bar gives way to that close); price_source says whether price is a delayed quote or an official session close, and updated_at when it was observed. previous_close is split-adjusted to the price's session, and withheld with the change when that session is on another share basis than the close with no split on record yet. Requires quotes.read, eod.read and an entitled market. Supply exactly one of symbols or instrument_ids. Every requested symbol is either a row of data or an entry of meta.errors: unresolved symbols and instrument IDs are reported there (when none of them resolves the response is 404 instead, whatever the size of the list), and so is a listing with neither a quote nor a session in the last 31 days, with code no-data. Error entries carry the instrument_id of the listing: the requested one, or the one a symbol resolved to; null when a symbol resolved to nothing." } }, { "name": "Top movers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/movers?direction=gainers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "movers" ], "query": [ { "key": "direction", "value": "gainers", "description": "gainers (default) or losers." }, { "key": "limit", "value": "", "description": "Rows to return, from 1 to 50; default 20.", "disabled": true }, { "key": "exchanges", "value": "", "description": "Comma-separated ISO MIC codes, at most 100, each listed once. Defaults to every entitled exchange; mutual funds are ranked only for keys whose plan includes mutual-funds.read. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled. A mutual fund venue (NMFQ, FSRV) without mutual-funds.read returns 403 mutual-funds-not-entitled.", "disabled": true }, { "key": "min_price", "value": "", "description": "Minimum session close in the listing currency; default 1. Set 0 to include every price.", "disabled": true }, { "key": "min_volume", "value": "", "description": "Minimum session volume; default 100000. For exchange listings it is in shares, for crypto pairs in the quote currency. Currency pairs, indices and bonds have no volume, so they are ranked only with min_volume=0.", "disabled": true }, { "key": "date", "value": "", "description": "Trading date (YYYY-MM-DD) of the session to rank, compared with each market's session before it; defaults to each market's latest complete session. Must be within the plan history depth. Only the session on this date is ranked, never an earlier one: a market with no session on it (a weekend or holiday of its exchanges, or a date before its history) contributes no rows, and a date on which none of the requested markets traded returns an empty list. A session with no ranking yet (recent ones are kept ranked) is ranked by the first request for it; when that does not fit the request time budget, the response is 503 query-timeout with Retry-After, the ranking continues in the background, and a retry after the Retry-After interval is served from it.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Listings with the largest percent change from the previous session close to a session close, from reconciled end-of-day prices across the entitled markets (each market's latest complete session by default). Gainers rank the largest rises first and include only rises; losers rank the largest falls first and include only falls; ties break by listing. previous_close is split-adjusted, so a split is not a move. A listing whose session opened at least 90% away from its split-adjusted previous close is withheld from the ranking: a split can reach the feed up to a day after it takes effect, and until its record arrives such a session cannot be told from a gain or fall, so it is left out rather than ranked, and appears once the split is recorded. Listings without a bar on both sessions are not ranked. Requires eod.read and an entitled market; a key limited to a symbol list ranks only those symbols. Rankings of recent sessions are rebuilt within minutes of a change to their end-of-day bars." } }, { "name": "Cross-asset bars", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/bars?symbols=XNAS:AAPL&from=2026-09-01&to=2026-09-25&interval=1d", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bars" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "2026-09-01", "description": "First date (YYYY-MM-DD, inclusive) of window_start, the exchange-local trading date." }, { "key": "to", "value": "2026-09-25", "description": "Last date (YYYY-MM-DD, inclusive) of window_start; on or after from." }, { "key": "interval", "value": "1d", "description": "Required. 1d comes from end-of-day prices (/v1/eod). 5m and 1h come from the retained intraday bars of /v1/intraday (about 30 days): exchange listings are collected as five-minute bars, and 1h is rolled up from them, each session cut into hours from its open. 1m is served only by listings collected at one minute, which today are crypto and currency pairs; an interval a listing is not collected at (1m for exchange listings) returns 422 unsupported-interval. Weekly and monthly bars are not served." }, { "key": "session", "value": "", "description": "Default regular. Continuous markets (crypto and currency pairs) trade in one session a UTC day, so all selects the same bars as regular for them. Exchange listings have regular-session bars only, with no pre-market or after-hours bars; all returns 422 unsupported-session for them.", "disabled": true }, { "key": "adjustment", "value": "", "description": "Defaults to raw. split and total_return prices are rounded half up to 6 decimal places and adjusted volume to whole shares; a listing whose corporate actions are not collected (crypto and currency pairs, indices, bonds, OTC) returns 422 adjustment-unsupported for them.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on window_start; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Unified bars for exchange listings, crypto and currency pairs, indices and bonds, served from the same stores as /v1/eod (interval 1d, which also needs eod.read) and /v1/intraday (intraday intervals, which also need intraday.read). Requires exactly one of instrument_ids or symbols. Each listing serves the intervals it is collected at, and an interval it is not collected at returns 422 unsupported-interval; for crypto and currency pairs 5m and 1h are rolled up from 1m, and bonds have daily bars only. Prices are in currency_code; quote_instrument_id is null, since every crypto pair served is quoted in US dollars. Default order: window_start descending (newest first), id ascending. Instrument selection is required. Until a bar source publishes, bars are read from the price stores /v1/eod and /v1/intraday serve. Access requires the operation capability on the API key." } }, { "name": "Trades", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/trades?symbols=XNAS:AAPL&from=2026-09-18&to=2026-09-18", "host": [ "{{baseUrl}}" ], "path": [ "v1", "trades" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "2026-09-18", "description": "UTC date (YYYY-MM-DD) of event_at; a request reads one day." }, { "key": "to", "value": "2026-09-18", "description": "The same UTC date as from (YYYY-MM-DD)." }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on event_at; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Individual trade prints of one US-listed stock or ETF on one UTC date, from the consolidated tape (CTA and UTP): price, size, the executing exchange or FINRA reporting facility as a MIC, and normalized sale conditions. Requires exactly one instrument, as a single instrument_ids or symbols value, and from/to naming the same UTC date. A session's trades are available from the day after it trades, back to 2008, and each is knowable at the end of its New York trading day; the current session is not available. Trades are read on request rather than stored, so they carry no correction lineage: correction_of_id is always null and cancelled false. OTC Markets listings are included, and the plan history depth applies (403 before it). Past the provider's daily request limit the endpoint returns 503 with Retry-After until midnight UTC. Quote snapshots are not trade ticks. Default order: event_at ascending, id ascending. Instrument selection and bounded range are required. Read from the trade source on request; 503 dataset-unavailable when that source is switched off or does not answer, and when it has reached its daily request limit, with Retry-After until 00:00 UTC. Access requires the operation capability on the API key." } } ] }, { "name": "Financials", "item": [ { "name": "Financial facts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/financials/facts?symbols=XNAS:AAPL&from=2025-01-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "financials", "facts" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Comma-separated MIC:TICKER symbols (crypto pairs are CRYPTO:BTC-USD, currency pairs FOREX:EUR-USD, indices INDEX:GSPC, bonds BOND and the ISIN, such as BOND:US00037BAF94) or bare tickers, which resolve to the exchange listing that ticker; neither part is case-sensitive, and two spellings of one listing count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. At most 100, further limited by the effective plan and key scope. A symbol names the listing recorded under it at symbol_at; at a date before any ticker is recorded for a listing, the earliest ticker recorded for it selects it as well (see symbol_at). Supply symbols or instrument_ids." }, { "key": "instrument_ids", "value": "", "description": "Comma-separated stable instrument IDs (the instrument_id of each row, and of the research endpoints) instead of symbols; each selects its listing at any date, including history from before its earliest recorded ticker and listings that no longer trade. Rows carry the symbol the listing had at symbol_at, or where it had none then, its symbol at as_of, else the last one it carried by as_of, else its first. At most 100. Cannot be combined with symbols.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. A ticker names the listing that carries it at symbol_at, and every row of a from/to range carries that symbol, rows from before the listing took the ticker included: a ticker reused after its earlier holder delisted returns the new holder's older rows, so set symbol_at inside the range to name the listing that traded under the ticker then. Tickers are recorded only where there is evidence for them (for many listings from 2003, though prices start earlier), and none is asserted earlier. As a lookup convenience, a date before a listing's earliest recorded ticker still finds the listing by that ticker when no record contradicts it (no listing is recorded under the ticker by that date, and the listing has no earlier ticker): its rows carry the symbol as a label and meta.unrecorded_symbols lists it. A date before the listing's first row returns 200 with no-data, as a to before it does. A ticker another listing held, or one the listing was renamed from or to, returns 404 naming the date and the listing; instrument_ids select a listing at any date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "from", "value": "2025-01-01", "description": "First fiscal_end to include (YYYY-MM-DD)." }, { "key": "to", "value": "2026-09-25", "description": "Last fiscal_end to include (YYYY-MM-DD); on or after from, so from equal to to selects one day." }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known. Filters eligible revisions; not a change feed or deletion log.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on fiscal_end, asc (default) or desc; ties keep their internal order in the same direction. The cursor is bound to it.", "disabled": true }, { "key": "concepts", "value": "", "description": "Exact source taxonomy concept names.", "disabled": true }, { "key": "taxonomy", "value": "", "description": "Exact source taxonomy namespace.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Point-in-time facts as reported in the XBRL of SEC filings, read from SEC EDGAR: one record per taxonomy concept, fiscal period and unit, with the source filing. Only consolidated (non-dimensional) facts are carried; segment figures are in /v1/financials/segments. Issuers that do not file with the SEC have no facts. For normalized statements use /v1/financials/statements. Default order: requested symbol, then fiscal_end ascending, then concept. Select listings with symbols or instrument_ids, not both; order=desc returns each listing's rows newest first. Requires fundamentals.read and an entitled market. An empty data array is a successful result. When none of the requested symbols resolves, the response is 404 symbol-not-resolved, whatever the size of the list; when at least one does, the others are reported in meta.errors." } }, { "name": "Financial concepts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/financials/concepts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "financials", "concepts" ], "query": [ { "key": "statement", "value": "", "description": "Statement family.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Discover the normalized concepts that /v1/financials/statements lines use: label, description, statement family, unit and whether each measures a period or an instant. Source taxonomy tags are not served; /v1/financials/facts has the as-filed facts. Default order: id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Financial statements", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/financials/statements?symbols=XNAS:AAPL&from=2025-01-01&to=2026-12-31", "host": [ "{{baseUrl}}" ], "path": [ "v1", "financials", "statements" ], "query": [ { "key": "company_ids", "value": "", "description": "Filter by issuer IDs. May be combined with instrument selectors; filters intersect, except on issuer-level datasets (statements, segments, estimates, earnings, insider transactions), where an instrument selector is read as its company and takes the place of company_ids, so results cover every share class.", "disabled": true }, { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "statement", "value": "", "description": "Statement family.", "disabled": true }, { "key": "period", "value": "", "description": "Fiscal period; defaults to quarterly.", "disabled": true }, { "key": "from", "value": "2025-01-01", "description": "Inclusive lower bound on period_end." }, { "key": "to", "value": "2026-12-31", "description": "Inclusive upper bound on period_end; must be on or after from, so from equal to to selects one day." }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on period_end; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Normalized quarterly and annual statements with a restatement-aware knowledge cutoff. Trailing-twelve-month statements are not offered: four quarters of the connected source do not reliably add up to its annual statement (cash-flow lines in particular), so sum quarters yourself only where they reconcile to the annual figure. period_start, fiscal_year and fiscal_quarter are not supplied by the connected source and are null; period_end is the source's date for the period: the calendar month end for a company on a 52-week year (a quarter ending June 27 is dated 2026-06-30). filing_ids names the issuer's original SEC 10-Q, 10-K, 10-KT, 20-F or 40-F, known at as_of, whose reported period ends within 10 days of period_end (a fourth quarter's is the annual report), and reported_period_end is that filing's own period end; both are empty or null where no stored filing matches, such as an issuer outside EDGAR or a period before it. Each statement is checked for internal consistency before it is published: a line that repeats, negates or doubles another line (income tax equal to income before tax, a profit equal to revenue while net income is not), or a total that cannot be negative, is withheld; a wide miss of an accounting identity, or a part that exceeds its whole (gross profit over revenue, current over total assets), is flagged; and quality_issues lists both, along with any line OHLC withheld or corrected on review; check it before relying on a statement's lines. Default order: period_end ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Metric definitions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/financials/metric-definitions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "financials", "metric-definitions" ], "query": [ { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Discover the formulas, units and input concepts of valuation, profitability, growth, dividend and historical market capitalization metrics. Default order: id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Financial metrics", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/financials/metrics?symbols=XNAS:AAPL&from=2026-09-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "financials", "metrics" ], "query": [ { "key": "company_ids", "value": "", "description": "Filter by issuer IDs. May be combined with instrument selectors; filters intersect, except on issuer-level datasets (statements, segments, estimates, earnings, insider transactions), where an instrument selector is read as its company and takes the place of company_ids, so results cover every share class.", "disabled": true }, { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "metrics", "value": "", "description": "IDs from financials/metric-definitions.", "disabled": true }, { "key": "from", "value": "2026-09-01", "description": "Inclusive lower bound on observed_on." }, { "key": "to", "value": "2026-09-25", "description": "Inclusive upper bound on observed_on; must be on or after from, so from equal to to selects one day." }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on observed_on; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Historical valuations, market capitalization, growth, dividend and financial ratios, with input lineage. Each value is the listing's (instrument_id) and names its company (company_id); /v1/financials/metric-definitions describes how each metric is calculated. A calculated value lists the records it was calculated from in input_record_ids; enterprise_value converts a balance sheet in another currency than the market capitalization at the exchange rate of observed_on, and is left out without one. Preferred shares carry no issuer-level metrics (market capitalization, enterprise value, valuation ratios); their dividend metrics come from their own dividend history. dividend_yield is OHLC's, calculated from the dividends the listing itself paid over the trailing 365 days and its latest reconciled close (trailing_dividend_yield is the same value under its first name); the provider's payout_ratio is left out for listings whose statements or earnings are reported in another currency than they trade in (most ADRs). forward_dividend_yield annualises only a payment cadence the dividend history establishes, and dividends paid in another currency than the listing trades in are converted at the exchange rate of the day they detach. Default order: observed_on ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Revenue segments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/financials/segments?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "financials", "segments" ], "query": [ { "key": "company_ids", "value": "", "description": "Filter by issuer IDs. May be combined with instrument selectors; filters intersect, except on issuer-level datasets (statements, segments, estimates, earnings, insider transactions), where an instrument selector is read as its company and takes the place of company_ids, so results cover every share class.", "disabled": true }, { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "dimension", "value": "", "description": "Segment axis.", "disabled": true }, { "key": "from", "value": "", "description": "Inclusive lower bound on period_end.", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive upper bound on period_end; must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on period_end; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Issuer-reported revenue by operating segment, product or service line and geographic area, with segment operating income where the issuer reports it, from the XBRL of each company's annual report filed with the SEC (10-K or 10-KT, or its amendment when no original is held). One record per company, fiscal year end, breakdown and segment; the figures are the fiscal year's, and a company's history starts with the annual report OHLC first read. Segment names are the issuer's own and are not comparable across companies, and a breakdown may hold totals beside their parts, so do not add a company's segments up. Companies that report a single segment have no records. Default order: period_end ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } } ] }, { "name": "Company data", "item": [ { "name": "Corporate actions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/corporate-actions?symbols=XNAS:AAPL&from=2020-01-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "corporate-actions" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Comma-separated MIC:TICKER symbols (crypto pairs are CRYPTO:BTC-USD, currency pairs FOREX:EUR-USD, indices INDEX:GSPC, bonds BOND and the ISIN, such as BOND:US00037BAF94) or bare tickers, which resolve to the exchange listing that ticker; neither part is case-sensitive, and two spellings of one listing count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. At most 100, further limited by the effective plan and key scope. A symbol names the listing recorded under it at symbol_at; at a date before any ticker is recorded for a listing, the earliest ticker recorded for it selects it as well (see symbol_at). Supply symbols or instrument_ids, or omit both for a market-wide request, which from and to must bound." }, { "key": "instrument_ids", "value": "", "description": "Comma-separated stable instrument IDs (the instrument_id of each row, and of the research endpoints) instead of symbols; each selects its listing at any date, including history from before its earliest recorded ticker and listings that no longer trade. Rows carry the symbol the listing had at symbol_at, or where it had none then, its symbol at as_of, else the last one it carried by as_of, else its first. At most 100. Cannot be combined with symbols.", "disabled": true }, { "key": "exchanges", "value": "", "description": "Market-wide requests only (no symbols or instrument_ids): comma-separated ISO MIC codes, at most 100. Defaults to every exchange of the entitled markets. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. A ticker names the listing that carries it at symbol_at, and every row of a from/to range carries that symbol, rows from before the listing took the ticker included: a ticker reused after its earlier holder delisted returns the new holder's older rows, so set symbol_at inside the range to name the listing that traded under the ticker then. Tickers are recorded only where there is evidence for them (for many listings from 2003, though prices start earlier), and none is asserted earlier. As a lookup convenience, a date before a listing's earliest recorded ticker still finds the listing by that ticker when no record contradicts it (no listing is recorded under the ticker by that date, and the listing has no earlier ticker): its rows carry the symbol as a label and meta.unrecorded_symbols lists it. A date before the listing's first row returns 200 with no-data, as a to before it does. A ticker another listing held, or one the listing was renamed from or to, returns 404 naming the date and the listing; instrument_ids select a listing at any date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "from", "value": "2020-01-01", "description": "First ex_date to include (YYYY-MM-DD). Required without symbols or instrument_ids." }, { "key": "to", "value": "2026-09-25", "description": "Last ex_date to include (YYYY-MM-DD); on or after from, so from equal to to selects one day. Required without symbols or instrument_ids, at most 365 days after from." }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known. Filters eligible revisions; not a change feed or deletion log.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on ex_date, asc (default) or desc; ties keep their internal order in the same direction. The cursor is bound to it.", "disabled": true }, { "key": "types", "value": "", "description": "Corporate-action type codes: cash_dividend or split. Any other code is accepted and matches no action.", "disabled": true }, { "key": "effective_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) of effective_at. No current source states effective_at, so this filter matches no action today; bound ex_date with from and to instead.", "disabled": true }, { "key": "effective_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) of effective_at; on or after effective_from. No current source states effective_at, so this filter matches no action today; bound ex_date with from and to instead.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Point-in-time consensus actions and their cash/security legs. Default order: requested symbol, then ex_date ascending (undated actions last); without symbols or instrument_ids, ex_date ascending across listings. Select listings with symbols or instrument_ids, not both; order=desc returns each listing's rows newest first. Without symbols or instrument_ids, returns every entitled listing's rows (optionally only those on exchanges) for a from-to window of at most 366 days counting both, newest first with order=desc; plans limited to named symbols see only those. Each such row names its listing by its symbol at symbol_at, or its last symbol before then. Requires corporate-actions.read and an entitled market. An empty data array is a successful result. When none of the requested symbols resolves, the response is 404 symbol-not-resolved, whatever the size of the list; when at least one does, the others are reported in meta.errors." } }, { "name": "Dividends", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/dividends?symbols=XNAS:AAPL&from=2025-01-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dividends" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Comma-separated MIC:TICKER symbols (crypto pairs are CRYPTO:BTC-USD, currency pairs FOREX:EUR-USD, indices INDEX:GSPC, bonds BOND and the ISIN, such as BOND:US00037BAF94) or bare tickers, which resolve to the exchange listing that ticker; neither part is case-sensitive, and two spellings of one listing count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. At most 100, further limited by the effective plan and key scope. A symbol names the listing recorded under it at symbol_at; at a date before any ticker is recorded for a listing, the earliest ticker recorded for it selects it as well (see symbol_at). Supply symbols or instrument_ids, or omit both for a market-wide request, which from and to must bound." }, { "key": "instrument_ids", "value": "", "description": "Comma-separated stable instrument IDs (the instrument_id of each row, and of the research endpoints) instead of symbols; each selects its listing at any date, including history from before its earliest recorded ticker and listings that no longer trade. Rows carry the symbol the listing had at symbol_at, or where it had none then, its symbol at as_of, else the last one it carried by as_of, else its first. At most 100. Cannot be combined with symbols.", "disabled": true }, { "key": "exchanges", "value": "", "description": "Market-wide requests only (no symbols or instrument_ids): comma-separated ISO MIC codes, at most 100. Defaults to every exchange of the entitled markets. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. A ticker names the listing that carries it at symbol_at, and every row of a from/to range carries that symbol, rows from before the listing took the ticker included: a ticker reused after its earlier holder delisted returns the new holder's older rows, so set symbol_at inside the range to name the listing that traded under the ticker then. Tickers are recorded only where there is evidence for them (for many listings from 2003, though prices start earlier), and none is asserted earlier. As a lookup convenience, a date before a listing's earliest recorded ticker still finds the listing by that ticker when no record contradicts it (no listing is recorded under the ticker by that date, and the listing has no earlier ticker): its rows carry the symbol as a label and meta.unrecorded_symbols lists it. A date before the listing's first row returns 200 with no-data, as a to before it does. A ticker another listing held, or one the listing was renamed from or to, returns 404 naming the date and the listing; instrument_ids select a listing at any date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "from", "value": "2025-01-01", "description": "First ex_date to include (YYYY-MM-DD). Required without symbols or instrument_ids." }, { "key": "to", "value": "2026-09-25", "description": "Last ex_date to include (YYYY-MM-DD); on or after from, so from equal to to selects one day. Required without symbols or instrument_ids, at most 365 days after from." }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known. Filters eligible revisions; not a change feed or deletion log.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on ex_date, asc (default) or desc; ties keep their internal order in the same direction. The cursor is bound to it.", "disabled": true }, { "key": "types", "value": "", "description": "Corporate-action type codes: cash_dividend or split. Any other code is accepted and matches no action.", "disabled": true }, { "key": "effective_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) of effective_at. No current source states effective_at, so this filter matches no action today; bound ex_date with from and to instead.", "disabled": true }, { "key": "effective_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) of effective_at; on or after effective_from. No current source states effective_at, so this filter matches no action today; bound ex_date with from and to instead.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Cash dividends with ex, record and pay dates, cash/security legs, frequency, split-adjusted amounts and cumulative dividend adjustment factors, and for ASX listings the exchange's announcement: fiscal period, franking (imputation credits), withholding, specials and the dividend reinvestment plan. Filters from and to apply to ex_date. Default order: requested symbol, then ex_date ascending (undated actions last); without symbols or instrument_ids, ex_date ascending across listings. Select listings with symbols or instrument_ids, not both; order=desc returns each listing's rows newest first. Without symbols or instrument_ids, returns every entitled listing's rows (optionally only those on exchanges) for a from-to window of at most 366 days counting both, newest first with order=desc; plans limited to named symbols see only those. Each such row names its listing by its symbol at symbol_at, or its last symbol before then. Requires corporate-actions.read and an entitled market. An empty data array is a successful result. When none of the requested symbols resolves, the response is 404 symbol-not-resolved, whatever the size of the list; when at least one does, the others are reported in meta.errors." } }, { "name": "Splits", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/splits?symbols=XNAS:AAPL&from=2020-01-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "splits" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Comma-separated MIC:TICKER symbols (crypto pairs are CRYPTO:BTC-USD, currency pairs FOREX:EUR-USD, indices INDEX:GSPC, bonds BOND and the ISIN, such as BOND:US00037BAF94) or bare tickers, which resolve to the exchange listing that ticker; neither part is case-sensitive, and two spellings of one listing count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. At most 100, further limited by the effective plan and key scope. A symbol names the listing recorded under it at symbol_at; at a date before any ticker is recorded for a listing, the earliest ticker recorded for it selects it as well (see symbol_at). Supply symbols or instrument_ids, or omit both for a market-wide request, which from and to must bound." }, { "key": "instrument_ids", "value": "", "description": "Comma-separated stable instrument IDs (the instrument_id of each row, and of the research endpoints) instead of symbols; each selects its listing at any date, including history from before its earliest recorded ticker and listings that no longer trade. Rows carry the symbol the listing had at symbol_at, or where it had none then, its symbol at as_of, else the last one it carried by as_of, else its first. At most 100. Cannot be combined with symbols.", "disabled": true }, { "key": "exchanges", "value": "", "description": "Market-wide requests only (no symbols or instrument_ids): comma-separated ISO MIC codes, at most 100. Defaults to every exchange of the entitled markets. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. A ticker names the listing that carries it at symbol_at, and every row of a from/to range carries that symbol, rows from before the listing took the ticker included: a ticker reused after its earlier holder delisted returns the new holder's older rows, so set symbol_at inside the range to name the listing that traded under the ticker then. Tickers are recorded only where there is evidence for them (for many listings from 2003, though prices start earlier), and none is asserted earlier. As a lookup convenience, a date before a listing's earliest recorded ticker still finds the listing by that ticker when no record contradicts it (no listing is recorded under the ticker by that date, and the listing has no earlier ticker): its rows carry the symbol as a label and meta.unrecorded_symbols lists it. A date before the listing's first row returns 200 with no-data, as a to before it does. A ticker another listing held, or one the listing was renamed from or to, returns 404 naming the date and the listing; instrument_ids select a listing at any date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "from", "value": "2020-01-01", "description": "First execution_date to include (YYYY-MM-DD). Required without symbols or instrument_ids." }, { "key": "to", "value": "2026-09-25", "description": "Last execution_date to include (YYYY-MM-DD); on or after from, so from equal to to selects one day. Required without symbols or instrument_ids, at most 365 days after from." }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known. Filters eligible revisions; not a change feed or deletion log.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on execution_date, asc (default) or desc; ties keep their internal order in the same direction. The cursor is bound to it.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Splits and reverse splits, including stock dividends paid in the listing's own shares, which the source records as splits (forward_split), with split ratios and cumulative price adjustment factors. Splits at whose ex-date prices did not move, and spin-off or rights-offering price adjustments the source records as splits but which distribute no shares, are not listed; /v1/eod still applies the latter to prices (not volume), so adjusted bars before one differ from the product of the listed splits. Filters from and to apply to execution_date as the source recorded it, which differs from the published date only for a split recorded on a day the exchange was closed. A split usually reaches the feed before it executes; one can arrive up to a day after, and until it does the bars of its execution_date are on the new share basis without a split record. Default order: requested symbol, then execution_date ascending; without symbols or instrument_ids, execution_date ascending across listings. Select listings with symbols or instrument_ids, not both; order=desc returns each listing's rows newest first. Without symbols or instrument_ids, returns every entitled listing's rows (optionally only those on exchanges) for a from-to window of at most 366 days counting both, newest first with order=desc; plans limited to named symbols see only those. Each such row names its listing by its symbol at symbol_at, or its last symbol before then. Requires corporate-actions.read and an entitled market. An empty data array is a successful result. When none of the requested symbols resolves, the response is 404 symbol-not-resolved, whatever the size of the list; when at least one does, the others are reported in meta.errors." } }, { "name": "Filings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/filings?symbols=XNAS:AAPL&from=2026-01-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "filings" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Comma-separated MIC:TICKER symbols (crypto pairs are CRYPTO:BTC-USD, currency pairs FOREX:EUR-USD, indices INDEX:GSPC, bonds BOND and the ISIN, such as BOND:US00037BAF94) or bare tickers, which resolve to the exchange listing that ticker; neither part is case-sensitive, and two spellings of one listing count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. At most 100, further limited by the effective plan and key scope. A symbol names the listing recorded under it at symbol_at; at a date before any ticker is recorded for a listing, the earliest ticker recorded for it selects it as well (see symbol_at). Supply symbols or instrument_ids." }, { "key": "instrument_ids", "value": "", "description": "Comma-separated stable instrument IDs (the instrument_id of each row, and of the research endpoints) instead of symbols; each selects its listing at any date, including history from before its earliest recorded ticker and listings that no longer trade. Rows carry the symbol the listing had at symbol_at, or where it had none then, its symbol at as_of, else the last one it carried by as_of, else its first. At most 100. Cannot be combined with symbols.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. A ticker names the listing that carries it at symbol_at, and every row of a from/to range carries that symbol, rows from before the listing took the ticker included: a ticker reused after its earlier holder delisted returns the new holder's older rows, so set symbol_at inside the range to name the listing that traded under the ticker then. Tickers are recorded only where there is evidence for them (for many listings from 2003, though prices start earlier), and none is asserted earlier. As a lookup convenience, a date before a listing's earliest recorded ticker still finds the listing by that ticker when no record contradicts it (no listing is recorded under the ticker by that date, and the listing has no earlier ticker): its rows carry the symbol as a label and meta.unrecorded_symbols lists it. A date before the listing's first row returns 200 with no-data, as a to before it does. A ticker another listing held, or one the listing was renamed from or to, returns 404 naming the date and the listing; instrument_ids select a listing at any date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "from", "value": "2026-01-01", "description": "First filed_on to include (YYYY-MM-DD)." }, { "key": "to", "value": "2026-09-25", "description": "Last filed_on to include (YYYY-MM-DD); on or after from, so from equal to to selects one day." }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known. Filters eligible revisions; not a change feed or deletion log.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on filed_on, asc (default) or desc; ties keep their internal order in the same direction. The cursor is bound to it.", "disabled": true }, { "key": "forms", "value": "", "description": "Exact regulatory form types, such as 8-K, 10-K or 10-Q.", "disabled": true }, { "key": "period_from", "value": "", "description": "Inclusive lower bound on period_end (YYYY-MM-DD).", "disabled": true }, { "key": "period_to", "value": "", "description": "Inclusive upper bound on period_end (YYYY-MM-DD); must be on or after period_from.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Issuer filings filtered by filing date, form type and reporting period. The index holds annual, quarterly and current reports (10-K, 10-Q, 8-K, and 20-F, 40-F and 6-K of foreign issuers) and their amendments, filed since September 23, 2024. Ownership forms (3, 4, 5), registration statements, proxy statements and earlier filings are not indexed. Default order: requested symbol, then filed_on ascending. Select listings with symbols or instrument_ids, not both; order=desc returns each listing's rows newest first. Requires filings.read and an entitled market. An empty data array is a successful result. When none of the requested symbols resolves, the response is 404 symbol-not-resolved, whatever the size of the list; when at least one does, the others are reported in meta.errors." } }, { "name": "Companies", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/companies?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "key": "company_ids", "value": "", "description": "Filter by issuer IDs. May be combined with instrument selectors; filters intersect, except on issuer-level datasets (statements, segments, estimates, earnings, insider transactions), where an instrument selector is read as its company and takes the place of company_ids, so results cover every share class.", "disabled": true }, { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "countries", "value": "", "description": "ISO 3166-1 alpha-2 country codes.", "disabled": true }, { "key": "q", "value": "", "description": "Case-insensitive company name search. Without order, the best matches come first: an exact name, then names that start with the text, then other matches, the company with the most traded listing first within each. A value that is empty or only whitespace returns 422.", "disabled": true }, { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Issuer profiles, sector and industry, officers, branding and listings. There is one profile per listed security's issuer: an ETF or mutual fund is profiled as itself, and a preferred series or a second share class has its own profile and company_id next to the common stock's. Issuer-level datasets (statements, segments, earnings, estimates, insider transactions, news) resolve any share class to the company's records. classifications is empty until a coded scheme is connected. Default order: id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Analyst estimates", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/estimates?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "estimates" ], "query": [ { "key": "company_ids", "value": "", "description": "Filter by issuer IDs. May be combined with instrument selectors; filters intersect, except on issuer-level datasets (statements, segments, estimates, earnings, insider transactions), where an instrument selector is read as its company and takes the place of company_ids, so results cover every share class.", "disabled": true }, { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "metric", "value": "", "description": "Estimated metric: eps or revenue; ebitda matches nothing, as the connected source gives no EBITDA consensus.", "disabled": true }, { "key": "period", "value": "", "description": "Forecast fiscal period.", "disabled": true }, { "key": "from", "value": "", "description": "Inclusive lower bound on period_end.", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive upper bound on period_end; must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on period_end; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Latest consensus estimate snapshot at or before effective_date for each issuer, metric and fiscal period: EPS and revenue, as the mean, low and high estimate with the number of analysts, in the company's reporting currency. The connected source gives no median (median.value is always null), period_start or fiscal_year (both null); fiscal_quarter is the quarter the source names. EPS estimates carry the upward and downward revisions of the last 30 days; revenue estimates carry none. as_of prevents later revisions entering historical queries. Default order: period_end ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Analyst ratings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/analyst-ratings?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "analyst-ratings" ], "query": [ { "key": "company_ids", "value": "", "description": "Filter by issuer IDs. May be combined with instrument selectors; filters intersect, except on issuer-level datasets (statements, segments, estimates, earnings, insider transactions), where an instrument selector is read as its company and takes the place of company_ids, so results cover every share class.", "disabled": true }, { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) of published_at.", "disabled": true }, { "key": "to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) of published_at; on or after from.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on published_at; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Analyst consensus snapshots: the consensus score from 1 (strong sell) to 5 (strong buy), the number of analysts at each recommendation and the mean price target, one record per listing each time its profile is refreshed (about monthly), with the price target in the listing's trading currency. Individual analyst actions are not available from the connected source, so every record is rating_type consensus and firm, analyst, previous_rating and previous_target_price are null; normalized_rating is unrated for numeric consensus scores. History begins on 2026-09-26, when OHLC began recording the consensus; the source keeps no earlier snapshots. Default order: published_at ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Filing sections", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/filings/:filing_id/sections", "host": [ "{{baseUrl}}" ], "path": [ "v1", "filings", ":filing_id", "sections" ], "query": [ { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "filing_id", "value": "0000320193-24-000123", "description": "SEC accession number, as accession_number in /v1/filings." } ] }, "description": "Narrative text of an existing filing: Item 1 Business, Item 1A Risk Factors and Item 7 MD&A of 10-K filings, and each item of 8-K filings, amendments included. Other forms and other sections are not covered. Sections attach to filings in /v1/filings by accession number and are published the morning after the filing date; history covers about two years of filings. A section longer than 256 KiB is cut and marked truncated. An accession number with no sections, whether the filing is covered, not covered or not indexed, returns 200 data: []. Default order: id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Filing exhibits", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/filings/:filing_id/exhibits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "filings", ":filing_id", "exhibits" ], "query": [ { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "filing_id", "value": "0000320193-24-000123", "description": "SEC accession number, as accession_number in /v1/filings." } ] }, "description": "Exhibits of an existing filing as its SEC EDGAR filing index lists them: each EX- document (99.1 press releases, 10.x material contracts, 31 and 32 certifications, the 101 XBRL files, 104 cover page and so on) in document order, with its exhibit number, the filer's description (the exhibit type when the filer gave none), a link to the document on SEC EDGAR and its media type. Exhibits attach to filings in /v1/filings by accession number, every indexed form and its amendments (10-K, 10-Q, 8-K, 20-F, 40-F, 6-K), and are read within about an hour of the filing being indexed; history is filled back to about two years of filings. The document itself is not stored or served. An accession number with no exhibits, whether the filing is covered, not covered or not indexed, returns 200 data: []. Default order: id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Companies by ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":id" ], "query": [ { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "id", "value": "01M35H2KDW9VT69S5ZCEGMCPAX", "description": "Stable public record ID." } ] }, "description": "Fetch one accessible record by public ID at the knowledge cutoff. Includes inactive or expired records. Returns 404 when absent or inaccessible, 503 when dataset coverage is unavailable, and 501 when no source is connected to the dataset." } } ] }, { "name": "Reference data", "item": [ { "name": "Securities", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/securities?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "securities" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Comma-separated MIC:TICKER symbols (crypto pairs are CRYPTO:BTC-USD, currency pairs FOREX:EUR-USD, indices INDEX:GSPC, bonds BOND and the ISIN, such as BOND:US00037BAF94) or bare tickers, which resolve to the exchange listing that ticker; neither part is case-sensitive, and two spellings of one listing count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. At most 100, further limited by the effective plan and key scope. A symbol names the listing recorded under it at symbol_at; at a date before any ticker is recorded for a listing, the earliest ticker recorded for it selects it as well (see symbol_at). Supply symbols or instrument_ids." }, { "key": "instrument_ids", "value": "", "description": "Comma-separated stable instrument IDs (the instrument_id of each row, and of the research endpoints) instead of symbols; each selects its listing at any date, including history from before its earliest recorded ticker and listings that no longer trade. Rows carry the symbol the listing had at symbol_at, or where it had none then, its symbol at as_of, else the last one it carried by as_of, else its first. At most 100. Cannot be combined with symbols.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. A ticker names the listing that carries it at symbol_at, and every row of a from/to range carries that symbol, rows from before the listing took the ticker included: a ticker reused after its earlier holder delisted returns the new holder's older rows, so set symbol_at inside the range to name the listing that traded under the ticker then. Tickers are recorded only where there is evidence for them (for many listings from 2003, though prices start earlier), and none is asserted earlier. As a lookup convenience, a date before a listing's earliest recorded ticker still finds the listing by that ticker when no record contradicts it (no listing is recorded under the ticker by that date, and the listing has no earlier ticker): its rows carry the symbol as a label and meta.unrecorded_symbols lists it. A date before the listing's first row returns 200 with no-data, as a to before it does. A ticker another listing held, or one the listing was renamed from or to, returns 404 naming the date and the listing; instrument_ids select a listing at any date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Effective security identity and symbol assignment at symbol_at: valid_from and valid_to bound the whole stretch the listing has carried that symbol without a break. Select listings with symbols or instrument_ids, not both. Requires reference.read and an entitled market. An empty data array is a successful result. When none of the requested symbols resolves, the response is 404 symbol-not-resolved, whatever the size of the list; when at least one does, the others are reported in meta.errors." } }, { "name": "Symbol search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/symbols/search?q=AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "symbols", "search" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "exchanges", "value": "", "description": "Comma-separated ISO MIC codes, at most 100, each listed once. Defaults to all entitled exchanges. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled.", "disabled": true }, { "key": "q", "value": "AAPL", "description": "Case-insensitive ticker prefix; omit it to list every symbol. A value that is empty or only whitespace returns 422." }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Current symbol assignments matching a case-insensitive ticker prefix. q also matches the other spellings of a share class or series (BRK.B, BRK-B and BRK/B find the same listing; BAC-PL as BAC.PRL or BAC PRL), and results are in the order each assignment was recorded. Requires reference.read and an entitled market. An empty data array is a successful result." } }, { "name": "Exchanges", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/exchanges", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exchanges" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "exchanges", "value": "", "description": "Comma-separated ISO MIC codes, at most 100, each listed once. Defaults to all entitled exchanges. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Entitled exchange reference data and trading conventions. Requires exchanges.read and an entitled market. An empty data array is a successful result." } }, { "name": "Market calendar", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/calendar?exchanges=XNAS&date=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "calendar" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged. Changes to entitlements can invalidate it.", "disabled": true }, { "key": "exchanges", "value": "XNAS", "description": "Comma-separated ISO MIC codes, at most 100, each listed once. Defaults to all entitled exchanges. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled." }, { "key": "date", "value": "2026-09-25", "description": "Exchange-local YYYY-MM-DD date; defaults to today in each exchange timezone. Outside the range every requested exchange calendar covers, 422; outside one of several, that exchange is named in meta.errors." }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Latest calendar revision and sessions for an exchange-local date. US exchange calendars run from the 1950s through the end of the published NYSE holiday schedule (2028-12-31), holidays and early closes included. The Toronto, TSX Venture, Cboe Canada, London, Euronext Paris and Amsterdam and ASX calendars, and that of FSRV (Canadian mutual funds, which keeps Toronto's), run through the same date: the provider's about 45 days ahead, and after that the days each exchange's holiday rules give, early closes included, which the provider's replace as its calendar reaches them (a closing announced for one year is known only then). The crypto venue trades every day, so it has a row for any date from 2010-07-01 on, and the forex venue every day but Saturday, from 1970-01-01 on (a Saturday row is closed), trading from Sunday 17:00 to Friday 17:30 New York time. The index venue is open every day from 1900-01-01 through about a month ahead, with the UTC day as its session: each index trades on its own market's days, and has a bar only where its market traded. The bond venue is open every weekday from 2000-01-01 through about a month ahead, with the UTC day as its session, and closed on weekends; a bond has a bar only on the days it traded. A date that no requested exchange calendar covers returns 422 naming their range; a requested exchange whose calendar alone does not reach the date has no row and is named in meta.errors by its exchange_mic. GET /v1/datasets/calendar/coverage gives each calendar's first and last date as history_from and history_to (history_to is null only for CRYPTO and FOREX, which trade continuously). Requires calendar.read and an entitled market. An empty data array is a successful result." } }, { "name": "Instruments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/instruments?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "instruments" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "asset_type", "value": "", "description": "Asset class.", "disabled": true }, { "key": "status", "value": "", "description": "Default active. The security master was built in September 2026 from the listings its sources still carried and records delistings from then on, so nearly every delisted listing it holds stopped trading in 2026, and most issuers delisted earlier, such as TWTR or SIVB, are not held. all is therefore not a survivorship-free historical universe.", "disabled": true }, { "key": "countries", "value": "", "description": "ISO 3166-1 alpha-2 country codes of the listing's exchange; with exchanges, the exchanges in these countries. The CRYPTO, FOREX, INDEX and BOND venues have no country (ZZ).", "disabled": true }, { "key": "exchanges", "value": "", "description": "Listing MICs. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled.", "disabled": true }, { "key": "q", "value": "", "description": "Case-insensitive name or symbol search. Without order, the best matches come first: an exact ticker, then an exact name, then names that start with the text, then other matches, the most traded first within each. A value that is empty or only whitespace returns 422.", "disabled": true }, { "key": "identifier_type", "value": "", "description": "Must be supplied together with identifier.", "disabled": true }, { "key": "identifier", "value": "", "description": "Exact identifier; requires identifier_type. May return multiple related listings. A CIK's leading zeroes are optional. Only listings with a provider profile match, so OTC listings, crypto and currency pairs, indices and bonds are not found this way (a bond is BOND: in symbols).", "disabled": true }, { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Cross-asset discovery, listing lifecycle and issuer links. Default status=active. identifier and identifier_type must be supplied together. Default order: id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Symbol history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/instruments/:instrument_id/symbols", "host": [ "{{baseUrl}}" ], "path": [ "v1", "instruments", ":instrument_id", "symbols" ], "query": [ { "key": "from", "value": "", "description": "First date (YYYY-MM-DD, inclusive) on which a symbol took effect, on the exchange's local calendar.", "disabled": true }, { "key": "to", "value": "", "description": "Last date (YYYY-MM-DD, inclusive) on which a symbol took effect; on or after from.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on valid_from; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "instrument_id", "value": "01M35H2KE2ZJHXFY5C3E7FPC66", "description": "Stable public identifier." } ] }, "description": "Effective-dated aliases, including retired tickers. Default order: valid_from ascending, id ascending. Results are limited to the entitled scope. Served from the OHLC security master, exchange calendars and reference tables. Access requires the operation capability on the API key." } }, { "name": "Instrument identifiers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/instruments/:instrument_id/identifiers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "instruments", ":instrument_id", "identifiers" ], "query": [ { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "instrument_id", "value": "01M35H2KE2ZJHXFY5C3E7FPC66", "description": "Stable public identifier." } ] }, "description": "External identifiers of a listing as its provider profile states them: ISIN, CUSIP and FIGI identify the listing, CIK and LEI its issuer. valid_from and valid_to are null, since the source does not date them, and effective_date does not narrow the list; as_of bounds when an identifier became known. The security master's CIK and FIGI links are in /v1/tickers. Default order: id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Crypto assets", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/crypto/assets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "crypto", "assets" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Crypto asset IDs: a coin's ID, which is a pair's base_instrument_id; a pair's own instrument_id matches no row.", "disabled": true }, { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Crypto asset metadata and supply; trading pairs remain separate instruments with base/quote IDs. One row per coin with a profile (name, links, supply, market capitalization, and for tokens their network and contract): one source's supply and market capitalization are read daily for every coin it prices (about nine in ten listed pairs), the other's profile of the leading coins weekly, and the newest observation is served, with market_cap and fully_diluted_market_cap carried to the latest daily close in between. A pair whose coin neither source profiles is in /v1/tickers and /v1/eod but not here. Default order: id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "All tickers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/tickers?q=AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tickers" ], "query": [ { "key": "q", "value": "AAPL", "description": "Case-insensitive ticker prefix in any spelling (BRK.B, BRK/B, BACpL), or text whose every word occurs anywhere in the listing's name. A value that is empty or only whitespace returns 422." }, { "key": "types", "value": "", "description": "Security type codes: those of /v1/ticker-types (such as CS, PFD or ETF), FUND for mutual funds, BOND for bonds, CRYPTO for crypto pairs, FOREX for currency pairs or INDEX for indices. A code that is not one of these returns 422.", "disabled": true }, { "key": "asset_types", "value": "", "description": "Asset classes, as in /v1/instruments.", "disabled": true }, { "key": "exchanges", "value": "", "description": "Listing MICs. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled.", "disabled": true }, { "key": "countries", "value": "", "description": "ISO 3166-1 alpha-2 country codes.", "disabled": true }, { "key": "active", "value": "", "description": "true lists listings trading at date; false lists listings that no longer trade, under the last ticker each traded as; all lists both. Earlier tickers of a listing are in /v1/instruments/{instrument_id}/symbols. The security master was built in September 2026 from the listings its sources still carried and records delistings from then on, so nearly every delisted listing it holds stopped trading in 2026, and most issuers delisted earlier, such as TWTR or SIVB, are not held.", "disabled": true }, { "key": "date", "value": "", "description": "Point in time: listing state and ticker at the end of this UTC date. Defaults to now. Tickers are effective-dated; names, types and identifiers are the latest recorded. A listing appears only where a ticker is recorded for it at date: ticker records begin in 2003 at the earliest and later for many listings, so an early date lists few of the listings whose prices reach back to it (history_from).", "disabled": true }, { "key": "cik", "value": "", "description": "Issuer SEC CIK; leading zeroes are optional.", "disabled": true }, { "key": "figi", "value": "", "description": "Composite or share-class FIGI.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on ticker; listings sharing a ticker follow in the same direction.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Every listing in the security master for the entitled markets, active or delisted, with its ticker, name, identifiers and security type at date. Filter by ticker prefix or name, type, asset class, exchange, country, CIK or FIGI. Holidays and trading hours are in /v1/calendar and /v1/market-status. Default order: ticker ascending, then listing. Results are limited to the entitled scope. Served from the OHLC security master, exchange calendars and reference tables. Access requires the operation capability on the API key." } }, { "name": "Ticker types", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/ticker-types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ticker-types" ], "query": [ { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "US security type codes from the reference source (asset_class stocks, locale us), with their names. /v1/tickers also reports and accepts FUND for mutual funds, BOND for bonds, CRYPTO for crypto pairs, FOREX for currency pairs and INDEX for indices, which this list does not carry. Default order: code ascending. Results are limited to the entitled scope. Served from the OHLC security master, exchange calendars and reference tables. Access requires the operation capability on the API key." } }, { "name": "Trade and quote conditions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/conditions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "conditions" ], "query": [ { "key": "types", "value": "", "description": "Condition types, such as sale_condition or quote_condition.", "disabled": true }, { "key": "data_types", "value": "", "description": "Data types: trade, bbo or nbbo.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Condition codes that qualify US stock trades and quotes, with their securities information processor mappings and whether a trade updates high, low, open, close and volume. Default order: type ascending, then id ascending. Results are limited to the entitled scope. Served from the OHLC security master, exchange calendars and reference tables. Access requires the operation capability on the API key." } }, { "name": "Market status", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/market-status?exchanges=XNAS", "host": [ "{{baseUrl}}" ], "path": [ "v1", "market-status" ], "query": [ { "key": "exchanges", "value": "XNAS", "description": "Exchange MICs; defaults to every entitled exchange with a published calendar. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled." }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Whether each entitled exchange is open now, in pre-market or after-hours trading, closed or on a holiday, with today's session and the next open and close, from the published exchange calendar. pre_market and after_hours apply to US exchanges only (04:00 to 20:00 New York time, or until four hours after an early close); other exchanges have no extended hours. The CRYPTO, FOREX, INDEX and BOND venues follow their own calendars in /v1/calendar, and INDEX says nothing about the market of any one index. next_open_at and next_close_at are null when no session falls within the next 14 days. Upcoming holidays and past sessions are in /v1/calendar. Default order: exchange MIC ascending. Results are limited to the entitled scope. Served from the OHLC security master, exchange calendars and reference tables. Access requires the operation capability on the API key." } }, { "name": "Ticker events", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/instruments/:instrument_id/events", "host": [ "{{baseUrl}}" ], "path": [ "v1", "instruments", ":instrument_id", "events" ], "query": [ { "key": "from", "value": "", "description": "Inclusive lower bound on date.", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive upper bound on date; must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "instrument_id", "value": "01M35H2KE2ZJHXFY5C3E7FPC66", "description": "Stable public identifier." } ] }, "description": "Ticker and venue changes of one listing, derived from its effective-dated symbol assignments: each event is the exchange-local date a new MIC:TICKER took effect and the one it replaced. An event whose ticker equals previous_ticker is a move between exchanges, such as an uplisting from OTC. as_of excludes assignments recorded after it. Default order: date ascending, id ascending. Results are limited to the entitled scope. Served from the OHLC security master, exchange calendars and reference tables. Access requires the operation capability on the API key." } }, { "name": "Instruments by ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/instruments/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "instruments", ":id" ], "query": [ { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "id", "value": "01M35H2KE2ZJHXFY5C3E7FPC66", "description": "Stable public record ID." } ] }, "description": "Fetch one accessible record by public ID at the knowledge cutoff. Includes inactive or expired records. Returns 404 when absent or inaccessible, 503 when dataset coverage is unavailable, and 501 when no source is connected to the dataset." } } ] }, { "name": "Delivery", "item": [ { "name": "Create export", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exports" ] }, "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"eod\",\n \"parameters\": {\n \"symbols\": [\n \"XNAS:AAPL\"\n ],\n \"from\": \"2026-09-01\",\n \"to\": \"2026-09-25\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Queue a private NDJSON export. Requires bulk.download and the selected dataset capability. parameters uses the selected security endpoint query contract. An export holds at most 1,000,000 rows and 256 MiB; a larger one ends with status failed, so split the range. Endpoint exports read the data as of when the export is built unless parameters set as_of. Alternatively use resource (collection path template) and parameters for research collections. Path IDs belong in parameters. Research exports pin as_of at creation. Neither kind takes limit or cursor in parameters: an export reads every page of the result." } }, { "name": "Export status and download", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/exports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exports", ":id" ], "query": [ { "key": "download", "value": "", "description": "Set true to download the NDJSON file instead of the JSON status.", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-4000-8000-000000000001", "description": "Export ID returned by POST /v1/exports." } ] }, "description": "Only the creating account and API key can access the export. download=true returns NDJSON when ready; before the export is ready it returns 409 export-not-ready. Status requests return JSON until the export expires; after that every request, status or download, returns 409 export-expired. Downloads contain one dataset row per NDJSON line, without the REST envelope, and expire one day after generation. Current authorization is rechecked throughout downloads." } }, { "name": "List flat files", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/flat-files", "host": [ "{{baseUrl}}" ], "path": [ "v1", "flat-files" ], "query": [ { "key": "dataset", "value": "", "description": "Only this dataset.", "disabled": true }, { "key": "from", "value": "", "description": "Inclusive first trading date (YYYY-MM-DD).", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive last trading date (YYYY-MM-DD); must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum files per page, from 1 to 500; default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour. Keep all query parameters unchanged.", "disabled": true } ] }, "description": "Per-trading-date gzipped CSV files for the US market, newest date first: eod (daily bars) and corporate-actions (dividends and splits that take effect that day). Files hold the rows GET /v1/eod and /v1/corporate-actions return for that New York trading date, except mutual funds (NMFQ), which only plans with mutual-funds.read may read and which /v1/eod and exports serve; files are published by the nightly build after the date and rebuilt for five trading days (the latest two hourly) so corrections republish changed files; the sha256 and generated_at change with each republication. Daily-bar and corporate-action files are kept; they exist from the first trading date the nightly build published (the oldest file listed), and earlier history is read from /v1/eod or an export. There are no intraday files: US listings are collected as five-minute bars, which /v1/intraday serves for 30 days. Requires flat-files.read (Pro, Commercial and Scale) and each listed dataset capability; without dataset only entitled datasets are listed. Dates before the plan history depth are omitted." } }, { "name": "Flat file metadata and download", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/flat-files/:dataset/:date", "host": [ "{{baseUrl}}" ], "path": [ "v1", "flat-files", ":dataset", ":date" ], "query": [ { "key": "download", "value": "", "description": "Set true to download the .csv.gz file instead of its JSON metadata.", "disabled": true } ], "variable": [ { "key": "dataset", "value": "eod", "description": "eod or corporate-actions." }, { "key": "date", "value": "2026-09-25", "description": "New York trading date (YYYY-MM-DD)." } ] }, "description": "Metadata for one file, or with download=true the file itself: usually a 302 redirect to a presigned URL that is valid for five minutes and needs no API key, otherwise the gzip stream. Verify X-Content-SHA256. Requires flat-files.read (Pro, Commercial and Scale), the dataset capability (eod.read or corporate-actions.read), the US market and a date within the plan history depth. CSV files are UTF-8 with a header row; empty fields are null, instants are UTC RFC 3339 with microseconds, prices and volumes are exact decimal strings, booleans are true or false, and corporate-action legs are a JSON array. Each row carries instrument_id, the stable ID the REST endpoints return, as its last column; security_id holds the same value and is deprecated." } }, { "name": "Data health", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/health", "host": [ "{{baseUrl}}" ], "path": [ "v1", "health" ] }, "description": "Freshness and coverage in entitled markets, one row per dataset, market and exchange: where several sources deliver a venue, the row is as fresh as the freshest of them that has delivered there. freshness_status describes ingestion timing and, for daily and intraday bars, how many listings have the newest closed session (coverage.latest_session); status remains partial, unverified or unknown when completeness is not established. coverage.asset_types says which kinds of listing a price dataset covers on the venue. Symbols without rows may legitimately have no corporate actions. Coverage counts are operational observations, not entitlement-filtered data delivery. Missing observations have status unavailable. Research datasets no source is connected to yet (x-availability unavailable in this contract) are listed with their /v1/datasets id, a null exchange and status unavailable; their endpoints return 501 dataset-unavailable. coverage_configured is false when no ingestion coverage is configured for the markets of this key; no pagination." } }, { "name": "Credit usage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage" ] }, "description": "The account's daily credit allowance, credits spent since 00:00 UTC and credits remaining, shared by REST and MCP across every API key on the account, and the request limits that apply to it: requests_per_minute and concurrent_requests are account-wide, like the credits. Reading it costs no credits. limit and remaining are null for accounts without a daily limit; remaining also counts the account's unexpired welcome credits, so it can exceed limit minus used. concurrent_requests is the simultaneous-request limit that X-Concurrency-Limit reports (per key for unlimited entitlements); requests_per_minute is null when no rate limit applies." } }, { "name": "Datasets", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/datasets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datasets" ], "query": [ { "key": "as_of", "value": "", "description": "Not supported: only the current catalog is served, and any as_of returns 422 point-in-time-unavailable. Omit it.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Discover dataset implementation and account-specific readiness, supported filters and point-in-time availability. Default order: id ascending. Results are limited to the entitled scope. Never 501 or 503: a dataset with nothing published is reported as rows, implementation_status planned or availability unavailable in /v1/datasets and coverage status unavailable in /v1/datasets/{dataset}/coverage. Access requires the operation capability on the API key." } }, { "name": "Dataset coverage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/datasets/:dataset/coverage?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datasets", ":dataset", "coverage" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "countries", "value": "", "description": "ISO 3166-1 alpha-2 country codes.", "disabled": true }, { "key": "series_ids", "value": "", "description": "Series IDs.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD) for the coverage of a research dataset; cannot be in the future. A date before the dataset's history returns no rows. For core datasets (those of the core endpoints, such as eod and quotes), and for bars while they are read from end-of-day prices, any as_of returns 422 point-in-time-unavailable.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "dataset", "value": "eod", "description": "Dataset slug: the path after /v1/ with / written as ., such as eod or financials.statements. An unknown slug, or one outside the key's capabilities, returns 404 dataset-not-found." } ] }, "description": "Entitlement-filtered source coverage and historical extent. Coverage is evidence of readiness, not a blanket promise of complete data. delay_seconds is null. Rows are ordered by exchange_mic, country_code, instrument_id and series_id. A dataset with nothing published is reported as rows with status unavailable, not refused. Default order: id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Never 501 or 503: a dataset with nothing published is reported as rows, implementation_status planned or availability unavailable in /v1/datasets and coverage status unavailable in /v1/datasets/{dataset}/coverage. Access requires the operation capability on the API key." } } ] }, { "name": "News and sentiment", "item": [ { "name": "News", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/news?symbols=XNAS:AAPL&from=2026-09-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "news" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "2026-09-01", "description": "First UTC date (YYYY-MM-DD, inclusive) of published_at." }, { "key": "to", "value": "2026-09-25", "description": "Last UTC date (YYYY-MM-DD, inclusive) of published_at; on or after from." }, { "key": "q", "value": "", "description": "Indexed word-prefix search across title and summary: 1 to 10 whitespace-separated words of at least 3 letters or digits each, at most 256 characters in all. Punctuation, shorter words and more than 10 words return 422. Every word must match. No provider query language.", "disabled": true }, { "key": "topics", "value": "", "description": "Topics, matched exactly and case-sensitively against each article's topics, which are the publisher's own tags (an open set, such as earnings). Each is 1 to 100 characters without leading or trailing whitespace; anything else returns 422.", "disabled": true }, { "key": "languages", "value": "", "description": "Article languages as ISO 639-1 two-letter codes, such as en; case-insensitive. und selects articles whose language was not determined, which is most articles published before early July 2026, so add it to include them (languages=en,und). A value that is not an ISO 639-1 code or und returns 422.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on published_at; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Financial articles with security associations and licensed text. Unassociated market news is included when no instrument filter is supplied. Default order: published_at descending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "News sentiment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/news/sentiment?symbols=XNAS:AAPL&from=2026-09-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "news", "sentiment" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "2026-09-01", "description": "Inclusive lower bound on date." }, { "key": "to", "value": "2026-09-25", "description": "Inclusive upper bound on date; must be on or after from, so from equal to to selects one day." }, { "key": "interval", "value": "", "description": "UTC buckets; default 1d.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Per-instrument mean of the article sentiment scores /v1/news carries, one row per UTC day or Monday-starting UTC week. Each row averages the scores (-1 to 1, the same word-list tone measure as an article's sentiment.score, so most means are positive and close to 1) of the scored articles tagged to the listing and published in the bucket, each article counted once; articles without a score are left out of the mean and of article_count. A bucket is published shortly after its UTC day or week ends and recomputed over the next three days as late articles arrive, so a recent row can be revised. History reaches back as far as the stored articles. No scored article returns no row, not a neutral score. Default order: date ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "News by ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/news/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "news", ":id" ], "query": [ { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "id", "value": "record_511343eefdd551d912e9c754070d1e1f4da00d278c69c21621de40094e8e8dc6", "description": "Stable public record ID." } ] }, "description": "Fetch one accessible record by public ID at the knowledge cutoff. Includes inactive or expired records. Returns 404 when absent or inaccessible, 503 when dataset coverage is unavailable, and 501 when no source is connected to the dataset." } } ] }, { "name": "Company events", "item": [ { "name": "Earnings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/earnings?symbols=XNAS:AAPL&from=2025-01-01&to=2026-12-31", "host": [ "{{baseUrl}}" ], "path": [ "v1", "earnings" ], "query": [ { "key": "company_ids", "value": "", "description": "Filter by issuer IDs. May be combined with instrument selectors; filters intersect, except on issuer-level datasets (statements, segments, estimates, earnings, insider transactions), where an instrument selector is read as its company and takes the place of company_ids, so results cover every share class.", "disabled": true }, { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "2025-01-01", "description": "Inclusive lower bound on report_date." }, { "key": "to", "value": "2026-12-31", "description": "Inclusive upper bound on report_date; must be on or after from, so from equal to to selects one day." }, { "key": "status", "value": "", "description": "Announcement status: estimated (results not yet reported) or reported. The connected source reports neither confirmed nor cancelled announcements, so those match nothing.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on report_date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Upcoming and historical earnings announcements, actuals, estimates and surprises. The sources give the release date and session, not the instant, so report_at is always null. report_date is the source's release date, except where the source dates a reported quarter on or before its period end or with a later quarter's date: it is then the date of the company's first Form 8-K under Item 2.02 (results of operations) within 100 days after period_end, or null where there is none. Where report_date is null, from, to and ordering use period_end. eps_surprise and eps_surprise_ratio are the source's surprise and surprise percentage, the latter as a ratio. Revenue, fiscal year and fiscal quarter come from the company's statements and consensus for the same quarter, so an event known only from the earnings calendar carries none of them; period_start is not available. Default order: report_date descending (newest first), id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "IPOs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/ipos?from=2026-09-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ipos" ], "query": [ { "key": "from", "value": "2026-09-01", "description": "Inclusive lower bound on listing_date." }, { "key": "to", "value": "2026-09-25", "description": "Inclusive upper bound on listing_date; must be on or after from, so from equal to to selects one day." }, { "key": "exchanges", "value": "", "description": "Expected listing MICs. A malformed or repeated code returns 422 invalid-exchanges, a MIC the API does not serve 404 exchange-not-found, and one outside the key's markets 403 market-not-entitled.", "disabled": true }, { "key": "status", "value": "", "description": "Offering status.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on listing_date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Upcoming and historical initial public offerings on US exchanges (Nasdaq, NYSE, NYSE American, NYSE Arca, Cboe BZX), including issuers without a listed instrument yet. History starts in 2008. The connected sources date few offerings ahead of time, so most appear once they price or list, and only a handful are listed as expected at any time; an offering without a date is left out until it has one. OTC listings are not covered. Each offering keeps its id as it moves from expected to priced to listed, postponed or withdrawn; a postponed or withdrawn offering keeps the listing_date it was expected on. instrument_id and company_id are set once the offering has listed and its listing is in OHLC; expected_symbol is the source ticker on the expected exchange. Refreshed daily at 07:40 New York time. Default order: listing_date ascending, id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } } ] }, { "name": "Ownership and trading", "item": [ { "name": "Ownership", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/ownership?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ownership" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "holder_ids", "value": "", "description": "Holder IDs.", "disabled": true }, { "key": "holder_type", "value": "", "description": "Holder category.", "disabled": true }, { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on reported_on; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Latest reported position per instrument/holder on or before effective_date. The connected source lists each listing's 20 largest institutional holders and 10 largest fund holders as of their latest reports, not every holder, and keeps no earlier positions: history builds forward from September 2026, when OHLC began recording, and a holder that drops out of the largest keeps its last reported position. This is a position view, not a complete historical portfolio snapshot; absence is not proof of zero ownership. Default order: reported_on ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Insider transactions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/insider-transactions?from=2026-09-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "insider-transactions" ], "query": [ { "key": "company_ids", "value": "", "description": "Filter by issuer IDs. May be combined with instrument selectors; filters intersect, except on issuer-level datasets (statements, segments, estimates, earnings, insider transactions), where an instrument selector is read as its company and takes the place of company_ids, so results cover every share class.", "disabled": true }, { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "2026-09-01", "description": "Inclusive lower bound on transaction_date." }, { "key": "to", "value": "2026-09-25", "description": "Inclusive upper bound on transaction_date; must be on or after from, so from equal to to selects one day." }, { "key": "side", "value": "", "description": "Transaction direction.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on transaction_date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Structured insider disclosures from SEC Forms 4 and 5, one row per non-derivative transaction, preserving source transaction codes. Initial statements of holdings (Form 3) and derivative transactions (options and awards that convert) are not included. filing_id is the SEC accession number; filed_at and ownership_type are not available from the connected source. Default order: transaction_date ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Share statistics", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/share-statistics?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "share-statistics" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "", "description": "Inclusive lower bound on observed_on.", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive upper bound on observed_on; must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on observed_on; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Shares outstanding, free float and ownership ratios over time, each of the listing's own share class. Not published for preferred shares, whose source figures are the issuer's common share counts. Rows at quarter ends before OHLC's first observation of a listing (September 2026) are the company's share counts from its statements, every class together, so a company with more than one class of common stock (GOOGL and GOOG, BRK.A and BRK.B, or META beside its unlisted Class B) has none and its series starts at that first observation. float_shares is null for a listing that is one of several listed classes, whose source states one float for the whole company, and where the stated float exceeds the listing's shares outstanding (an ADR whose float is counted in ordinary shares). Default order: observed_on ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Short interest", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/short-interest?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "short-interest" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "", "description": "Inclusive lower bound on observed_on.", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive upper bound on observed_on; must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on observed_on; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Short positions as exchanges report them twice a month, one row per report OHLC observed. The connected source carries the latest report with each company profile refresh (about monthly, sooner after a filing) and does not date it, so observed_on is the day OHLC first saw the report, settlement_date and published_at are null, and a report published between two refreshes can be missed. Not published for preferred shares, whose source figures are the issuer's common stock's. History begins in September 2026. short_float_ratio is shares short over the free float, as a ratio (0.0088 means 0.88%). Default order: observed_on ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Short volume", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/short-volume?symbols=XNAS:AAPL&from=2026-09-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "short-volume" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "2026-09-01", "description": "Inclusive lower bound on date." }, { "key": "to", "value": "2026-09-25", "description": "Inclusive upper bound on date; must be on or after from, so from equal to to selects one day." }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Daily short sale volume that off-exchange venues and alternative trading systems reported to FINRA, per instrument and trade date, with a breakdown by reporting facility. Only FINRA-reported trades are counted, so total_volume is not the consolidated volume of the day and the ratio is not a short interest measure; reported short positions are in /v1/short-interest. A day becomes knowable when OHLC imports the published file, never earlier. Default order: date ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } } ] }, { "name": "Funds and indices", "item": [ { "name": "Funds", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/funds?symbols=ARCX:SPY", "host": [ "{{baseUrl}}" ], "path": [ "v1", "funds" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "ARCX:SPY", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "fund_type", "value": "", "description": "Fund type.", "disabled": true }, { "key": "countries", "value": "", "description": "ISO 3166-1 alpha-2 country codes.", "disabled": true }, { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "ETF and mutual-fund profiles and reported fund statistics: domicile, inception, expense ratio and assets under management, for mutual funds the net asset value, and for ETFs the benchmark index name, annual turnover and, for bond ETFs, duration, maturity, average coupon and price and yield to maturity. countries filters domicile. Mutual funds are included with plans that grant mutual-funds.read (Commercial and Scale): for other keys a mutual fund named by symbols or instrument_ids returns 403 mutual-funds-not-entitled, and a request without selectors, fund_type=mutual_fund included, leaves them out. Canadian mutual funds (FSRV) have prices and distributions but no profiles, holdings or allocations. Default order: id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Fund holdings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/funds/:instrument_id/holdings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "funds", ":instrument_id", "holdings" ], "query": [ { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on snapshot_date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "instrument_id", "value": "01M35ZNRDCZSWM3GGGF5HDGJ80", "description": "Stable public identifier." } ] }, "description": "The positions of one portfolio snapshot per fund, by weight; every page stays on the same snapshot. The connected source lists most ETFs' every position (SPY's 502), some ETFs' largest positions only and the 10 largest of a mutual fund, with weights only: meta.snapshot gives how many positions the snapshot lists and the share of the fund they cover, and quantity and market_value are null. holding links the listing a position trades as on any market OHLC carries, and provider_symbol keeps the position's own code either way. A new list far shorter than the fund's previous snapshot is not published; the previous snapshot stays. A fund that holds a commodity directly, such as a gold trust, lists no positions; its allocations describe it. Snapshots are monthly and the newest three are kept. An instrument that is not a fund returns 404 identifier-not-found, as an unknown ID does; a fund without a snapshot returns an empty list. A mutual fund's ID returns 403 mutual-funds-not-entitled for keys whose plan does not include mutual funds, and an ETF's positions in mutual funds are left out for those keys. Default order: snapshot_date ascending, id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Fund allocations", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/funds/:instrument_id/allocations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "funds", ":instrument_id", "allocations" ], "query": [ { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "dimension", "value": "", "description": "Allocation axis. sector, region, asset_class and market_cap are reported for ETFs and mutual funds, country for mutual funds only; the connected source reports no currency allocations, so currency returns an empty list.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on snapshot_date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "instrument_id", "value": "01M35ZNRDCZSWM3GGGF5HDGJ80", "description": "Stable public identifier." } ] }, "description": "Reported allocations from one eligible fund snapshot. An instrument that is not a fund returns 404 identifier-not-found, as an unknown ID does; a fund without a snapshot returns an empty list. A mutual fund's ID returns 403 mutual-funds-not-entitled for keys whose plan does not include mutual funds. Default order: snapshot_date ascending, id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Indices", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/indices", "host": [ "{{baseUrl}}" ], "path": [ "v1", "indices" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Equity indices whose constituents are published: the major US indices (the S&P 500, Nasdaq-100, Dow Jones Industrial Average, S&P MidCap 400 and S&P SmallCap 600, and the Russell 1000 and 2000), refreshed Tuesday to Saturday mornings (New York time) after each session, and about 160 other indices of the US, Canada, the United Kingdom, France, the Netherlands and Australia whose members the source lists and mostly trade on listings OHLC carries, such as the S&P 100, the NYSE Composite, the S&P/TSX Composite, the FTSE 100 and 250, the CAC 40, the AEX and the S&P/ASX 200, refreshed weekly. An index is listed for the keys whose plan includes the market most of its members trade in. Each index has an instrument_id of its own, the ID /v1/indices/{instrument_id}/constituents takes. An index is not a tradable listing, but its level is served as one under the INDEX venue, with the same instrument_id: the S&P 500 is INDEX:GSPC in /v1/eod, /v1/bars, /v1/snapshot and /v1/quotes, for keys whose plan includes index levels, alongside about 1,700 other indices worldwide. The Russell 1000 and 2000 and the FTSE UK indices (the FTSE 100, 250, 350, All-Share and AIM All-Share) have no levels: the source lists their members but does not price them. Default order: id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Index constituents", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/indices/:instrument_id/constituents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "indices", ":instrument_id", "constituents" ], "query": [ { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on snapshot_date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "instrument_id", "value": "32JE5160MJ9WHR6YT4Q1B11BBC", "description": "Stable public identifier." } ] }, "description": "Members of one index snapshot with each member's weight, as a ratio, and member_since, the date it last joined the index. Weights are given for the S&P 500, 400 and 600 and the Dow and are null for the Nasdaq-100, the Russell indices and most indices outside the US; member_since is given for most S&P 500 and S&P 400 members and is otherwise null. A snapshot is taken from the connected source's current membership and weights Tuesday to Saturday mornings (New York time) for the major US indices and weekly for the others, and the newest 20 snapshots of each index are kept, so effective_date reaches back about four weeks for the US indices and about twenty for the others; earlier membership is not reconstructed. Every page stays on the same snapshot. Members that do not resolve to a listing OHLC carries are left out, so a snapshot can list slightly fewer members than the index has; an index with fewer than half its members resolved is not published. An instrument that is not an index returns 404 identifier-not-found, as an unknown ID does, and so does an index level of the INDEX venue whose constituents are not published (such as INDEX:N225); /v1/indices lists those that are. Default order: snapshot_date ascending, id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Bonds", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/bonds?symbols=BOND:US00037BAF94", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bonds" ], "query": [ { "key": "company_ids", "value": "", "description": "Filter by issuer IDs. May be combined with instrument selectors; filters intersect, except on issuer-level datasets (statements, segments, estimates, earnings, insider transactions), where an instrument selector is read as its company and takes the place of company_ids, so results cover every share class.", "disabled": true }, { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "BOND:US00037BAF94", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "q", "value": "", "description": "Case-insensitive search of the bond name and symbol. A value that is empty or only whitespace returns 422.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "US-dollar corporate bonds, about 8,000, listed under the BOND venue by ISIN (BOND:US00037BAF94): each bond's terms (coupon, frequency, maturity, call features, seniority, issuer and its sector) and its latest price and yield to maturity. Bonds are included with Commercial and Scale; keys on other plans get 403 market-not-entitled. Prices are clean prices per 100 of face value, evaluated or last-trade, on the days a bond traded; the bond's daily history is in /v1/eod and /v1/bars (one price a day, open, high, low and close alike, no volume), and its yields in /v1/bonds/yields. The source states the maturity of few bonds, so most maturity_date values are read from the bond name (maturity_date_from_name); issuers are named as the source abbreviates them, and company_id links a bond to its company only on an exact name match. A record changes with each new price; as_of reads earlier records back seven days. Terms are read when a bond is first listed and monthly after. A bond that leaves the source's list keeps its last record; price_date shows when it last traded. Default order: id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Bond yields", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/bonds/yields?symbols=BOND:US00037BAF94&from=2026-09-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bonds", "yields" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "BOND:US00037BAF94", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "2026-09-01", "description": "Inclusive lower bound on date." }, { "key": "to", "value": "2026-09-25", "description": "Inclusive upper bound on date; must be on or after from, so from equal to to selects one day." }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A yield is known from when OHLC first held its current figures, so a date before that returns no rows for the bond rather than 422.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Daily price and yield to maturity of US corporate bonds (the BOND venue), as the source evaluates them, one row per bond and day traded: a bond has no row on a day it did not trade. History is held from 2021. A row is knowable from when OHLC first read its current figures; a revised figure replaces the one before it, which is not kept. Supply symbols or instrument_ids: omitting both returns 422. Bonds are included with Commercial and Scale; keys on other plans get 403 market-not-entitled. Default order: date descending (newest first), id ascending. Supply symbols or instrument_ids; results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } } ] }, { "name": "Options", "item": [ { "name": "Option contracts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/options/contracts?underlying_ids=01M35H2KE2ZJHXFY5C3E7FPC66", "host": [ "{{baseUrl}}" ], "path": [ "v1", "options", "contracts" ], "query": [ { "key": "underlying_ids", "value": "01M35H2KE2ZJHXFY5C3E7FPC66", "description": "Underlying instrument IDs." }, { "key": "contract_ids", "value": "", "description": "Option instrument IDs.", "disabled": true }, { "key": "type", "value": "", "description": "Option right.", "disabled": true }, { "key": "expiration_from", "value": "", "description": "Inclusive expiration date.", "disabled": true }, { "key": "expiration_to", "value": "", "description": "Inclusive expiration date; must be on or after expiration_from.", "disabled": true }, { "key": "strike_min", "value": "", "description": "Inclusive strike in the contract currency.", "disabled": true }, { "key": "strike_max", "value": "", "description": "Inclusive strike; must be >= strike_min.", "disabled": true }, { "key": "status", "value": "", "description": "Defaults to active; all includes expired contracts.", "disabled": true }, { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Discover chains by underlying, expiration and strike; expired contracts remain addressable. Status is evaluated at effective_date. Covers equity and ETF options listed in the US, not index options. Contracts are American-style; a standard contract delivers 100 shares of its underlying and settles physically, while one adjusted by a corporate action (its OCC root is not the underlying's ticker) lists no deliverables and settlement unknown. Default order: id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Option quotes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/options/quotes?underlying_ids=01M35H2KE2ZJHXFY5C3E7FPC66", "host": [ "{{baseUrl}}" ], "path": [ "v1", "options", "quotes" ], "query": [ { "key": "contract_ids", "value": "", "description": "Contract instrument IDs; mutually exclusive with underlying_ids.", "disabled": true }, { "key": "underlying_ids", "value": "01M35H2KE2ZJHXFY5C3E7FPC66", "description": "Underlying IDs for chain-wide snapshots; mutually exclusive with contract_ids." }, { "key": "expiration", "value": "", "description": "Contract expiration date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on event_at; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Latest eligible observation per option contract at as_of, including open interest and provider Greeks. Requires exactly one of contract_ids or underlying_ids; these collections are subject to batch and chain-size limits. Observations are end-of-day snapshots, timed at the session close and published the next morning; only the two newest daily snapshots are kept, so an earlier as_of returns no quotes. volume is the snapshot session's, 0 when the contract did not trade; implied_volatility and the Greeks are the provider's. Default order: event_at ascending, id ascending. Explicit contract/underlying selection is required. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Option bars", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/options/bars?contract_ids=inst_example_option", "host": [ "{{baseUrl}}" ], "path": [ "v1", "options", "bars" ], "query": [ { "key": "contract_ids", "value": "inst_example_option", "description": "Contract instrument IDs." }, { "key": "from", "value": "", "description": "Inclusive lower bound on date.", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive upper bound on date; must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Historical daily option OHLCV, one row per trading date the contract traded; sessions without a trade have no bar. Prices are raw. Read from the provider when requested; history starts in late 2023. For as_of, known_from and known_to, a bar is known at the end of its session's New York day. Default order: date descending (newest first), id ascending. Contract selection is required. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Option contracts by ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/options/contracts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "options", "contracts", ":id" ], "query": [ { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ], "variable": [ { "key": "id", "value": "record_example_1", "description": "Stable public record ID." } ] }, "description": "Fetch one accessible record by public ID at the knowledge cutoff. Includes inactive or expired records. Returns 404 when absent or inaccessible, 503 when dataset coverage is unavailable, and 501 when no source is connected to the dataset." } } ] }, { "name": "Analytics", "item": [ { "name": "Indicator definitions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/indicators/definitions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "indicators", "definitions" ], "query": [ { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Discover supported indicators: each one's formula, input bar fields, parameters with their limits and defaults, output names, and the warmup bars it needs at default parameters. Default order: id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Technical indicators", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/indicators?symbols=XNAS:AAPL&indicator=sma&from=2026-06-01&to=2026-09-25&interval=1d", "host": [ "{{baseUrl}}" ], "path": [ "v1", "indicators" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "indicator", "value": "sma", "description": "Code from indicators/definitions." }, { "key": "from", "value": "2026-06-01", "description": "First UTC date (YYYY-MM-DD, inclusive) of event_at." }, { "key": "to", "value": "2026-09-25", "description": "Last UTC date (YYYY-MM-DD, inclusive) of event_at; on or after from." }, { "key": "interval", "value": "1d", "description": "Source bar interval, as /v1/bars serves it: 1d for every listing, 5m and 1h for exchange listings, and 1m only for listings collected at one minute (crypto and currency pairs); otherwise 422 unsupported-interval. Weekly and monthly bars are not served." }, { "key": "period", "value": "", "description": "Lookback bars; only valid for indicators whose definition supports period. Without it, the definition's default applies: 20 for sma, ema and bollinger_bands, 14 for rsi, atr and stochastic, 12 for roc (GET /v1/indicators/definitions states each one's limits; rsi and bollinger_bands need at least 2).", "disabled": true }, { "key": "fast_period", "value": "", "description": "Optional indicator-specific fast period; macd defaults to 12.", "disabled": true }, { "key": "slow_period", "value": "", "description": "Optional slow period, greater than fast_period; macd defaults to 26.", "disabled": true }, { "key": "signal_period", "value": "", "description": "Optional signal period; macd defaults to 9 and stochastic to 3.", "disabled": true }, { "key": "adjustment", "value": "", "description": "Source-bar adjustment. Without it, bars are split-adjusted (meta.default_adjustment) for a listing with validated split adjustments, so a window that spans a split is on one share basis, and raw for a listing without them (crypto and currency pairs, indices, bonds, OTC), for which an explicit split or total_return returns 422 adjustment-unsupported. Each record's adjustment states what its bars had. raw reads bars as traded.", "disabled": true }, { "key": "session", "value": "", "description": "Source-bar session; default regular. Continuous markets (crypto and currency pairs) trade in one session a UTC day, so all selects the same bars as regular for them; exchange listings return 422 unsupported-session for anything but regular.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on event_at; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Calculated series with explicit inputs. Requires instrument_ids or symbols. Until a source publishes indicator values, they are calculated on request from end-of-day bars (interval 1d, which also needs eod.read) or the retained intraday bars of /v1/intraday (5m, and 1h rolled up from it, for exchange listings; these need intraday.read), under the same knowledge cutoff, adjustment and plan history depth as those bars; event_at is the close of each bar, and recursive indicators (ema, macd, rsi, atr) are seeded at the start of a warmup long enough that the seed's weight in each value is below 1e-20 (480 bars for a 20-day ema), so they equal, to the published eight places, values seeded from the earliest bar the key may read. Bars are split-adjusted by default where the listing has split adjustments, and raw otherwise; over a window with no later split the two give the same values. Definition defaults apply when indicator-specific parameters are omitted; unsupported parameter combinations return 422. Include preceding bars for warmup without emitting results before from; insufficient warmup produces null values. An indicator that cannot be calculated from stored bars returns 422 indicator-unavailable, and a request that would read more than 100,000 bars, or 50,000 for one instrument, returns 422 indicator-history-limit. Default order: event_at descending (newest first), id ascending. Instrument selection is required. Until a source publishes indicator values, they are calculated on request from stored bars. Access requires the operation capability on the API key." } }, { "name": "Screen instruments", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/screener", "host": [ "{{baseUrl}}" ], "path": [ "v1", "screener" ] }, "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"market_capitalization\",\n \"operator\": \"gte\",\n \"value\": \"1000000000\"\n },\n {\n \"field\": \"sector\",\n \"operator\": \"in\",\n \"values\": [\n \"Technology\"\n ]\n }\n ],\n \"currency_code\": \"USD\",\n \"sort\": {\n \"field\": \"market_capitalization\",\n \"direction\": \"desc\"\n },\n \"limit\": 100\n}", "options": { "raw": { "language": "json" } } }, "description": "Screen the entitled instrument universe using typed filters against a daily snapshot of every active listing, materialized after the evening end-of-day corrections. Numeric fields use latest eligible observations at as_of: close, volume and change_percent from the latest completed daily bar; valuation, yield and growth from versioned metric definitions; sector and industry from the company profile. Each snapshot is published at 22:30 New York time and the one before it is kept, so as_of reaches back to when the previous evening's snapshot finished publishing: between about one and two days. Any earlier as_of returns 422 point-in-time-unavailable naming the earliest available as_of. A body that states one JSON member twice, such as limit, returns 422 naming it; several filters on one field, such as close gte and close lte, combine as a range. Return the filter and sort fields used for each match. Data not available for a requested field returns 422, not an empty screen. Repeating a cursor requires the identical body except cursor. Default order: market_capitalization descending, instrument ID ascending; matches without the sort metric follow those that have it, so a screen for asset_type etf, crypto, forex or index, which carry no market capitalization, is best sorted on close or volume (an index has no volume). Default order: requested sort then instrument ID ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } } ] }, { "name": "Economics", "item": [ { "name": "Economic series", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/economic/series", "host": [ "{{baseUrl}}" ], "path": [ "v1", "economic", "series" ], "query": [ { "key": "countries", "value": "", "description": "ISO 3166-1 alpha-2 country codes.", "disabled": true }, { "key": "category", "value": "", "description": "Series category.", "disabled": true }, { "key": "q", "value": "", "description": "Case-insensitive series name search. A value that is empty or only whitespace returns 422.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Discover macro, Treasury curves, reference rates, funding/credit spreads, FX reference, commodity and housing series in one catalog. Coverage: US Federal Reserve data (Treasury constant-maturity yields, SOFR, EFFR, OBFR and TGCR with percentiles and volumes, BGCR, SOFR averages and index, Fed target range, IORB, CPI, PCE, labor, inflation expectations, commercial paper); the U.S. Treasury's daily bill rates, extra par curve tenors, real par yields and long-term rates; SONIA, the euro short-term rate (ESTR) and ECB and Bank of England policy rates; US funding spreads; the NY Fed corporate bond market distress index, the Treasury HQM corporate yield curve and CFTC CDS notionals; annual sovereign risk premiums, equity risk premiums, corporate tax rates and CDS spreads by country and default spreads by rating (world.sovereign_default_spread.{rating}); closing benchmark government bond yields of about 60 countries (yields, ID {country}.government_bond.yield.{tenor}); EURIBOR, euro swap and Canadian prime rates; ECB euro reference and Norges Bank exchange rates (fx); World Bank development indicators for about 50 economies and aggregates (ID {country}.wdi.{indicator}, annual); energy, metal and agricultural prices and commodity price indices (commodity); and BIS residential property price indices (real_estate). Each series names its original publisher; country series carry country_code, and aggregates (euro area, world, groups of economies) a null country_code and their region. Money is in currency_code units: commodity prices in US dollars per the unit the name states, exchange rates in units of currency_code per one unit of the named currency. Default order: id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Economic observations", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/economic/observations?series_ids=us.cpi.all_items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "economic", "observations" ], "query": [ { "key": "series_ids", "value": "us.cpi.all_items", "description": "Series IDs from economic/series." }, { "key": "from", "value": "", "description": "Inclusive lower bound on observation_date.", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive upper bound on observation_date; must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on observation_date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Revision-aware series observations. as_of selects the latest revision knowable at the cutoff for each series/date. All maturities of a curve are queried as a series set. observation_date is the day of a daily or weekly value and the first day of the month, quarter or year a monthly, quarterly or annual value describes, which period_start and period_end bound. Rates, yields and spreads are in percent (basis-point spreads divided by 100); published_at is the source's release instant where it states one (CFTC swap notionals) and null otherwise. Daily series are refreshed each weekday, World Bank, BIS property and sovereign risk series about monthly. Default order: observation_date ascending, id ascending. Series selection is required. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Economic calendar", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/economic/events?from=2026-09-01&to=2026-09-25", "host": [ "{{baseUrl}}" ], "path": [ "v1", "economic", "events" ], "query": [ { "key": "countries", "value": "", "description": "ISO 3166-1 alpha-2 country codes.", "disabled": true }, { "key": "series_ids", "value": "", "description": "Associated economic series. Events are not linked to series yet (series_id is null), so this filter matches none.", "disabled": true }, { "key": "from", "value": "2026-09-01", "description": "Inclusive lower bound on release_date." }, { "key": "to", "value": "2026-09-25", "description": "Inclusive upper bound on release_date; must be on or after from, so from equal to to selects one day." }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on release_date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Scheduled and historical economic releases with their actual, forecast and previous values. scheduled_at is the scheduled instant in UTC, null for an entry with no time of day; release_date is its UTC date. The connected source does not report the instant a figure was actually released (released_at), a revised previous value, an importance rating or measurement units, so those stay null or unknown; read the release name for the unit. Public holidays the source calendar lists are not releases and are left out. History comes from the source calendar, which begins in 2020, and is backfilled from the present backwards, so it can start later than 2020 while that runs; GET /v1/datasets/economic.events/coverage reports the current history_from and history_to. Upcoming releases appear about seven days ahead. series_id is null on every event: the calendar source links no release to a series. Default order: release_date ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Sovereign credit ratings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/economic/sovereign-ratings?countries=US", "host": [ "{{baseUrl}}" ], "path": [ "v1", "economic", "sovereign-ratings" ], "query": [ { "key": "countries", "value": "US", "description": "ISO 3166-1 alpha-2 country codes." }, { "key": "agency", "value": "", "description": "Rating agency.", "disabled": true }, { "key": "from", "value": "", "description": "Inclusive lower bound on observation_date.", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive upper bound on observation_date; must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on observation_date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Long-term foreign-currency credit ratings of about 160 sovereigns by Moody's, S&P and Fitch, one record per country, agency and annual edition, as compiled each January by Aswath Damodaran (NYU Stern) from the agencies' published ratings; the 2026 edition is the first held, and each later edition adds its own records. A rating an agency changes during the year appears with the next edition. notch places every agency's rating on one 22-step scale (1 is Aaa/AAA, 10 is Baa3/BBB-, the lowest investment grade), so ratings compare across agencies; a country an agency does not rate has no record for it. The matching default spreads and country risk premiums are economic series ({country}.sovereign.default_spread, {country}.sovereign.country_risk_premium). Default order: observation_date ascending, id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } } ] }, { "name": "Specialist data", "item": [ { "name": "ESG ratings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/ratings/esg?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ratings", "esg" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "", "description": "Inclusive lower bound on observed_on.", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive upper bound on observed_on; must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on observed_on; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Not yet available: no data source is connected to this dataset yet, so every request returns 501 dataset-unavailable. Provider-specific ESG scores with explicit scales (scale_min, scale_max, higher_is_better); scores of different providers are not comparable. Default order: observed_on ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Risk analytics", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/analytics/risk?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "analytics", "risk" ], "query": [ { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "", "description": "Inclusive lower bound on observed_on.", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive upper bound on observed_on; must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on observed_on; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Computed by OHLC each evening from its own end-of-day prices for active US listings: the trailing 252 daily simple returns (253 closes through the latest complete session), total-return adjusted (splits and cash dividends) where the listing's dividend history is valued, otherwise split-adjusted; listings without a validated split history are not computed. Volatility is the sample standard deviation times sqrt(252); Sharpe is mean daily return times 252 less the window's mean 3-month Treasury yield (H.15 DGS3MO; 0 when none is published), over that volatility; beta is cov(r, r_SPY) / var(r_SPY) against the US SPY listing; volatility, Sharpe and beta use returns between consecutive sessions only. A listing needs closes on the window's first and last sessions and on at least 80% of its sessions. risk_score and its scale are null. The newest two observation dates are kept; window_start and window_end state each record's window. Not arbitrary portfolio computation. Default order: observed_on ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Congressional trades", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/congressional-trades?symbols=XNAS:AAPL", "host": [ "{{baseUrl}}" ], "path": [ "v1", "congressional-trades" ], "query": [ { "key": "company_ids", "value": "", "description": "Filter by issuer IDs. May be combined with instrument selectors; filters intersect, except on issuer-level datasets (statements, segments, estimates, earnings, insider transactions), where an instrument selector is read as its company and takes the place of company_ids, so results cover every share class.", "disabled": true }, { "key": "instrument_ids", "value": "", "description": "Filter by stable instrument IDs. IDs and symbols may not be combined.", "disabled": true }, { "key": "symbols", "value": "XNAS:AAPL", "description": "Convenience lookup for exchange-listed instruments as MIC:TICKER or a bare ticker, which resolves to the exchange listing that ticker; resolves at symbol_at. The MIC and the ticker are case-insensitive, and two spellings of one listing (AAPL and XNAS:AAPL) count as a repeated value. A bare ticker that names no listing as written is also read in the common vendor spellings: with an exchange suffix (RY.TO, SHEL.L, VOD.LSE, BHP.AX), ^GSPC for INDEX:GSPC, and EURUSD=X or EURUSD for FOREX:EUR-USD. A ticker may contain a space (BAC PRL) but not start or end with one. A request in which no symbol resolves returns 404 symbol-not-resolved; otherwise each symbol that does not resolve, or resolves to a listing with no rows for the request (no-data), is an entry of meta.errors. IDs and symbols may not be combined." }, { "key": "symbol_at", "value": "", "description": "Resolve symbols as they were assigned at the end of this UTC date (YYYY-MM-DD); defaults to as_of. Only listings the security master holds resolve: it was built in September 2026 and records delistings from then on, so most issuers delisted earlier, such as TWTR or SIVB, resolve at no date. Only valid with symbols.", "disabled": true }, { "key": "from", "value": "", "description": "Inclusive lower bound on transaction_date.", "disabled": true }, { "key": "to", "value": "", "description": "Inclusive upper bound on transaction_date; must be on or after from, so from equal to to selects one day.", "disabled": true }, { "key": "chamber", "value": "", "description": "Congressional chamber.", "disabled": true }, { "key": "official_ids", "value": "", "description": "Filter by member: Bioguide IDs or the official_id of the rows.", "disabled": true }, { "key": "type", "value": "", "description": "Reported transaction type.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on transaction_date; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "Securities transactions that members of the U.S. House and Senate and their spouses and dependents report under the STOCK Act, one row per transaction of each periodic transaction report: from the House Clerk's financial disclosure site and the Senate's Electronic Financial Disclosure system, from 2012 (sparse before 2014). Refreshed every six hours; members have up to 45 days to report, so transaction dates trail by days to weeks. Rows keep the filed value range (amount_min, amount_max in USD; no exact amount is disclosed), the asset description and comment as filed, the owner, and the disclosure date and delay; a trade is public from disclosed_on. instrument and company_id link the US listing a reported ticker named on the transaction date when the listing's name agrees with the asset description (for options, the underlying listing), so symbols and instrument_ids select a security's trades; bonds, private holdings and unresolved tickers have none. Members are identified by Bioguide ID where known (official_id). A transaction date filed in a year after the disclosure (3031 for 2021) is read in the disclosure's year, or the year before when it would otherwise follow the disclosure. The source does not flag amended reports: an amendment that changes a row publishes a new revision of it, and a row it drops is withdrawn (as_of before the change still returns it). Party affiliation is not reported. Default order: transaction_date ascending, id ascending. Omitting entity selectors returns the entitled universe; explicit unauthorized selectors return 403. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } }, { "name": "Sanctions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sanctions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sanctions" ], "query": [ { "key": "q", "value": "", "description": "Case-insensitive word match over names and aliases, in id order; no identity-match score is implied. A value that is empty or only whitespace returns 422.", "disabled": true }, { "key": "countries", "value": "", "description": "ISO 3166-1 alpha-2 country codes.", "disabled": true }, { "key": "entity_type", "value": "", "description": "Entity type.", "disabled": true }, { "key": "status", "value": "", "description": "Defaults to active.", "disabled": true }, { "key": "effective_date", "value": "", "description": "Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.", "disabled": true }, { "key": "as_of", "value": "", "description": "Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.", "disabled": true }, { "key": "known_from", "value": "", "description": "First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.", "disabled": true }, { "key": "known_to", "value": "", "description": "Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.", "disabled": true }, { "key": "order", "value": "", "description": "Direction on id; ties use ID ascending.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum records per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.", "disabled": true }, { "key": "format", "value": "", "description": "Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.", "disabled": true } ] }, "description": "The US Treasury OFAC Specially Designated Nationals (SDN) list and Consolidated (non-SDN) list, merged into one record per OFAC entity: people, organizations, vessels and aircraft, with every alias and non-Latin spelling, ISO countries from addresses, nationality, citizenship and vessel flag, sanctions programs, and identifiers such as IMO and MMSI numbers, passports, national and tax IDs, SWIFT/BIC codes and digital currency addresses. Refreshed daily from OFAC's published exports, usually the evening (New York time) of the day OFAC acts. listed_on is the earliest date OFAC added the entity to one of these lists. OFAC drops delisted entries without a date, so an entity that leaves both lists stays here as removed, with removed_on the date OFAC's exports were first seen without it (status=removed or all returns them). Other jurisdictions' lists (UN, EU, UK) are not covered. A name match alone does not establish identity: confirm with the identifiers, dates and countries before acting on a match. Default order: id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key." } } ] } ] }