Instrument Data

Instruments

Thes instrument endpoints allows clients to discover, resolve, and inspect tradable instruments, including supported instruments, trading flags, marginability, and optional supplemental details.

For options workflows, clients can resolve an underlier, fetch available expirations, and retrieve paginated option contracts by underlier, expiry, and call/put side to build an option chain.

Name	Method	Path	Description
Instruments by ID	GET	/v1/instruments/{instrument_id}	Retrieves detailed information for a specific instrument.
List Instruments	GET	/v1/instruments	Retrieve a list of instruments. Note this will not return options
Search Instruments	GET	/v1/instruments/search	Search through instruments
List Option Contracts	GET	/v1/instruments/options/contracts	Lists options contracts. Returns options contracts for a given underlier with options-specific metadata. Exactly one underlier identifier must be provided.

List Instruments Query Parameters

Parameter	Type	Required	Notes
easy_to_borrow	boolean	No	Filter by ETB status.
instrument_ids	string	No	Comma-separated OEMS instrument UUIDs
is_liquidation_only	boolean	No	Filter by liquidation-only status.
instrument_type	enum	No	Examples: COMMON_STOCK, OPTION, PREFERRED_STOCK, CASH.
is_marginable	boolean	No	Filter by marginability.
is_ptp	boolean	No	Filter by publicly traded partnership (PTP) status.
is_short_prohibited	boolean	No	Filter by short-sale restriction.
is_threshold_security	boolean	No	Filter by Reg SHO threshold status.
page_size	integer	No	Defaults to 1000; used only on the first page.
page_token	string	No	Token for retrieving the next page of results. Contains encoded pagination state (limit + offset). When provided, page_size is ignored.

Instruments by ID Query Parameters

Parameter	Type	Required	Notes
instrument_id	path enum	Yes	instrument UUID
include_options_expiry_dates	boolean	No	When true, includes available option expiration dates for the instrument. Useful before loading an option chain.

Instruments Search Query Parameters

Parameter	Type	Required	Notes
q	string	Yes	Search term. Case-insensitive. Matches ticker symbols, company names and ID. Must be at least 1 non-whitespace character.
asset_class	CSV enum	No	Asset classes to search. Defaults to EQUITY. Supported values: EQUITY, OPTION, WARRANT, BOND, FX, OTHER.
country	string	No	Filter by listing country, e.g. US.
currency	string	No	Filter by ISO currency, e.g. USD.
include_inactive	boolean	No	Include publicly traded partnership (PTP) instruments. Defaults to true
include_ptp	boolean	No	Include restricted instruments. Defaults to true; restricted instruments may be ranked lower.
page_size	integer	No	Defaults to 1000; used only on the first page.
page_token	string	No

Instrument Response

The response for instrument by id, list instruments and instrument search follow the same pattern.

Field	Type	Definition
id	UUID	Unique instruments identifier
country_of_issue	string	ISO country code.
currency	string	ISO currency code.
easy_to_borrow	boolean	Whether the instrument is easy to borrow.
is_fractionable	boolean	Indicates if the instrument supports fractional-quantity orders
is_liquidation_only	boolean	Whether the instrument can only be liquidated.
is_marginable	boolean	Whether the instrument is marginable.
is_ptp	boolean	Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.
is_short_prohibited	boolean	Whether short selling is prohibited.
is_threshold_security	boolean	Whether the instrument is on the Reg SHO threshold list.
is_tradable	boolean	Whether the instrument is tradable
symbol	string	symbol of the instrument
venue	string	Primary listing venue MIC.
adv	decimal string	Average daily volume, when available.
expiry	date/null	Option expiration date, for option instruments.
instrument_type	enum	Security type, e.g. COMMON_STOCK, OPTION, WARRANT, CASH.
long_margin_rate	decimal string	Long margin requirement rate, when available.
name	string	Instrument or issuer name, when available.
notional_adv	decimal string	adv × previous_close, when available.
previous_close	decimal string	Previous close price, when available.
short_margin_rate	decimal string	Short margin requirement rate, when available.
strike_price	decimal string/null	Option strike price, for option instruments.

List Option Contracts Query Parameters

Parameter	Type	Required	Notes
contract_type	enum	No	CALL or PUT.
expiry	date	No	Filter contracts to one expiration date, YYYY-MM-DD.
underlier	string	Conditional	Direct underlier symbol, e.g. AAPL.
underlier_instrument_id	UUID	Conditional	instrument ID of the underlying equity. Preferred when known.
page_size	integer	No	Defaults to 1000; used only on the first page.
page_token	string	No	Token for retrieving the next page of results. Contains encoded pagination state (limit + offset). When provided, page_size is ignored.

List Option Contracts Response

Field	Type	Definition
id	UUID	Instrument ID for the option contract.
contract_type	enum	CALL or PUT.
currency	string	ISO currency code.
exchange	string	Listing venue MIC.
exercise_style	enum	AMERICAN or EUROPEAN.
expiry	date	Contract expiration date.
is_liquidation_only	boolean	Whether the contract can only be liquidated.
is_marginable	boolean	Whether the contract is marginable.
is_restricted	boolean	Whether trading is restricted.
listing_type	enum	STANDARD, FLEX, or OTC.
multiplier	decimal string	Contract multiplier, commonly 100.
strike_price	decimal string	Strike price.
symbol	string	OSI option symbol.
open_interest	integer	Open interest, when available.
underlier_instrument_id	UUID	ID of the underlier, when resolvable.

---

Instrument Events and Metrics

The Instruments and Market Data APIs provide a single surface for both reference data and prices. Use the instruments endpoints to pull corporate events, analyst consensus, company fundamentals, and financial statements going back multiple years. Use the market-data endpoints for latest quotes and daily open, high, low, volume data. Additionally you can keep up the latest with the News API.

Name	Method	Path	Description
All Instrument Events	GET	/v1/instruments/events	Returns all earnings, dividends, stock splits, and IPOs across instruments, grouped by event date
Instrument Events	GET	/v1/instruments/{instrument_id}/events	Returns earnings, dividends, stock splits, and IPOs across instruments, grouped by event date
Analyst ratings & price targets	GET	/v1/instruments/{instrument_id}/analyst-reporting	Returns the latest available analyst consensus snapshot, including rating distribution and aggregate price targets.
Fundamentals	GET	/v1/instruments/{instrument_id}/fundamentals	Returns supplemental company data for instruments including sector, industry, market cap, TTM EPS, P/E, beta, volume, 52-week range.

Instrument Financial Statements

Name	Method	Path	Description
Income Statements	GET	/v1/instruments/{instrument_id}/income-statements	Returns income statement rows with revenue, expenses, operating income, net income, EPS, and share count fields.
Balance Sheets	GET	/v1/instruments/{instrument_id}/balance-sheets	Returns balance sheet rows with assets, liabilities, equity, debt, and net debt fields.
Cash Flow Statements	GET	/v1/instruments/{instrument_id}/cash-flow-statements	Returns cash flow statement rows with operating, investing, financing, cash position, capital expenditure, and free cash flow fields.

Instrument Market Data

Name	Method	Path	Description
Snapshots	GET	/v1/market-data/snapshot	Returns latest quote, last trade, and session change metrics for one or more instruments
Daily Summaries	GET	/v1/market-data/daily-summary	Returns daily OHLV and current price summaries for up to 100 instrument UUID

---

News

Use the news endpoint for timely market news and press releases, filtered by instrument, publisher, sector, date range, or text search, with instrument associations included in each result.

Use Cases

Use Case	Description	Example
Watchlist news	Show one combined news feed across every instrument in a user’s watchlist.	GET /v1/news?instrument_ids={id1},{id2},{id3}
Portfolio or position monitoring	Help users understand news affecting instruments they currently hold or trade.	Query news for the instruments in a user’s active positions.
Research and discovery	Support keyword-based research across titles, article text, and associated security IDs.	GET /v1/news?search_query=earnings%20guidance
Publisher-specific feeds	Include preferred publishers or exclude noisy sources.	GET /v1/news?include_publishers=Reuters,Bloomberg
Sector news dashboard	Power sector overview pages or market pulse widgets.	GET /v1/news?sectors=TECHNOLOGY,FINANCIAL_SERVICES
Press release monitoring	Separate company-issued announcements from general market news.	GET /v1/news?news_type=PRESS_RELEASE&instrument_id=528ec5c3-cdbf-447c-b995-ec6c83cfbc02
Time-windowed market recap	Build daily, intraday, or session-specific news recaps.	GET /v1/news?from=2026-05-03&to=2026-05-03
Alerting and notifications	Notify users when new articles match a saved instrument or keyword filter.	Query with from={last_checked_at} for followed instruments.
AI or summary workflows	Feed relevant articles into an assistant, summary card, or research copilot.	Retrieve recent instrument news, then summarize catalysts, risks, or themes.

Query Parameters

Parameter	Description
exclude_publishers	Comma-separated publishers to exclude.
from, to	Inclusive publish-time range. Accepts YYYY-MM-DD or RFC3339 datetime.
include_publishers	Comma-separated publishers to include. Mutually exclusive with exclude_publishers.
instrument_ids	Comma-separated instrument UUIDs.
news_type	Filter by NEWS or PRESS_RELEASE.
page_size, page_token	Cursor-based pagination.
search_query	Free-text search across title, article text, and associated security IDs.
sectors	Comma-separated sectors to filter by.

---