> For AI agents: the documentation index is available at [llms.txt](https://docs.snaptrade.com/llms.txt), and the comprehensive documentation index is available at [llms-full.txt](https://docs.snaptrade.com/llms-full.txt). Download the [complete public OpenAPI specification](https://docs.snaptrade.com/openapi.yaml). Complete public OpenAPI specification with all documented operations, schemas, servers, and authentication requirements. Use it for SDK generation and API tooling; beta operations are marked x-beta. Markdown versions of documentation pages are available by appending .md to the URL path. > **Agent notice:** This is a beta endpoint. This endpoint’s request and response schemas and behavior may change without advance notice. When recommending or describing this endpoint, identify it as beta and include this compatibility warning. # Get account order detail > **Beta endpoint** This endpoint’s request and response schemas and behavior may change without advance notice. GET https://api.snaptrade.com/accounts/{accountId}/orders/{brokerageOrderId} Returns the detail of a single order, identified by the brokerage order ID in the path, in the same `kind`-discriminated format as `/accounts/{accountId}/orders/all`. The order carries a `legs` list with at least one leg; switch on `legs[].instrument.kind` and `order_type.kind` to know which fields are present. Multi-leg orders are a single order with multiple legs. This endpoint is always realtime and does not rely on cached data, except that an order in a terminal state (executed, canceled, rejected, failed, expired, replaced) may be served from a short-lived cache since it can no longer change. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. **Beta:** this endpoint and its response schema may change. Reference: https://docs.snaptrade.com/reference/Account%20Information/AccountInformation_getAccountOrder ## Code Examples ### TypeScript ```typescript import { Snaptrade, SnaptradeAuth, } from "snaptrade-typescript-sdk"; const snaptrade = new Snaptrade({ auth: SnaptradeAuth.commercialApiKey({ consumerKey: "CONSUMER_KEY", clientId: "CLIENT_ID", }), }); const response = await snaptrade.accountInformation.getAccountOrder( { accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631", brokerageOrderId: "66a033fa-da74-4fcf-b527-feefdec9257e", userId: "USER_ID", userSecret: "USER_SECRET", }, ); console.log(response.data); ``` ### Python ```python from pprint import pprint from snaptrade_client import SnapTrade, SnapTradeAuth snaptrade = SnapTrade( auth=SnapTradeAuth.commercial_api_key( consumer_key="CONSUMER_KEY", client_id="CLIENT_ID", ) ) response = snaptrade.account_information.get_account_order( account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631", brokerage_order_id="66a033fa-da74-4fcf-b527-feefdec9257e", user_id="USER_ID", user_secret="USER_SECRET" ) pprint(response.body) ``` ## OpenAPI Specification ```yaml openapi: 3.0.0 info: description: > Connect brokerage accounts to your app for live positions and trading. ## Rate limiting Two limits apply to requests signed with your `clientId`. The stricter one wins, and exceeding either returns `429 Too Many Requests`. - **Customer-level** — 250 requests/minute by default, scoped to your `clientId` and applied across all endpoints. Reported in `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. - **Account-level** — 10 requests/minute per account, scoped to (`clientId`, `accountId`). All covered operations for one account draw on the same bucket — reading balances and reading positions share it — and enforcement does not depend on the HTTP method, so updating an account consumes the same bucket as reading it. Only enforced for Personal users, and only for integrations it has been rolled out to — it is not yet in force for every Personal integration. It also does not apply on every operation that documents a 429 below. Where it applies it is reported in `X-RateLimit-Account-Limit`, `X-RateLimit-Account-Remaining` and `X-RateLimit-Account-Reset`. Do not read the absence of those headers as proof the limit is off — some configurations omit the rate limit headers while still enforcing the limit, so header absence tells you nothing about your allowance. On a 429, `X-RateLimit-Remaining: 0` means you hit the customer-level limit and `X-RateLimit-Account-Remaining: 0` means the account-level one. Wait for the corresponding `*-Reset` value (seconds) before retrying, or fall back to exponential backoff with jitter. Not every 429 is explained by those headers. A separate per-authenticated-user limit, reported in no `X-RateLimit-*` header, covers OAuth-authenticated requests and signed requests in configurations where the customer-level limit is not in effect — on the operations that use the default throttles. A few operations override those and are governed by the customer-level limit alone. The two do not stack: a signed request governed by the customer-level limit above is not additionally subject to the per-user one. If a 429 arrives with no header at zero — or with no `X-RateLimit-*` headers at all — honour `Retry-After` and back off. Treat the remaining counts as a hint, not a guarantee that the next request will succeed. Because the customer-level limit applies everywhere, any signed request can return 429. **OAuth-authenticated requests are an exception.** They are not subject to the customer-level limit and do not receive `X-RateLimit-Limit`, `X-RateLimit-Remaining` or `X-RateLimit-Reset` — do not wait on those headers or design around a customer-level allowance on this path. The account-level limit still applies to them on the account-data endpoints above, reported in the `X-RateLimit-Account-*` headers. On operations using the default throttles the per-user limit above applies to them as well, so an OAuth request can be rejected while the account headers still show capacity; on the few operations that override those throttles, OAuth callers have no per-user ceiling at all. Drive retries from `Retry-After` and exponential backoff with jitter rather than from the headers. See https://docs.snaptrade.com/docs/ratelimiting. version: 1.0.0 title: SnapTrade termsOfService: N/A contact: email: api@snaptrade.com x-konfig-ignore: potential-incorrect-type: true x-readme: explorer-enabled: false paths: /accounts/{accountId}/orders/{brokerageOrderId}: get: tags: - Account Information summary: Get account order detail operationId: AccountInformation_getAccountOrder description: > Returns the detail of a single order, identified by the brokerage order ID in the path, in the same `kind`-discriminated format as `/accounts/{accountId}/orders/all`. The order carries a `legs` list with at least one leg; switch on `legs[].instrument.kind` and `order_type.kind` to know which fields are present. Multi-leg orders are a single order with multiple legs. This endpoint is always realtime and does not rely on cached data, except that an order in a terminal state (executed, canceled, rejected, failed, expired, replaced) may be served from a short-lived cache since it can no longer change. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. **Beta:** this endpoint and its response schema may change. parameters: - in: path name: accountId required: true schema: description: >- Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. type: string format: uuid example: 917c8734-8470-4a3e-a18f-57c3f2ee6631 - in: path name: brokerageOrderId required: true schema: description: >- Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. type: string example: 66a033fa-da74-4fcf-b527-feefdec9257e responses: '200': description: OK content: application/json: schema: description: >- A single order. Single-leg orders have exactly one entry in `legs`; multi-leg orders (spreads, strangles, covered calls) have one entry per leg. type: object required: - brokerage_order_id - status - order_type - time_in_force - price_effect - legs properties: brokerage_order_id: description: >- Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. type: string example: 66a033fa-da74-4fcf-b527-feefdec9257e status: description: >- Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. type: string enum: - PENDING - REJECTED - CANCELED - CANCEL_PENDING - PARTIAL_CANCELED - EXECUTED - PARTIALLY_EXECUTED - REPLACED - REPLACE_PENDING - EXPIRED order_type: description: >- The order type and the prices that belong to it. Use `kind` to determine which fields are present. oneOf: - description: A market order. Executes at the best available price. type: object required: - kind properties: kind: type: string enum: - market example: market - description: >- A limit order. For multi-leg orders `limit_price` is the net price per spread; see `price_effect` for its direction. type: object required: - kind - limit_price properties: kind: type: string enum: - limit example: limit limit_price: description: >- The maximum price to pay for a buy, or the minimum price to accept for a sell. type: string format: decimal example: '12.34' - description: >- A stop order. Becomes a market order once `stop_price` is reached. type: object required: - kind - stop_price properties: kind: type: string enum: - stop example: stop stop_price: description: The price at which the order is triggered. type: string format: decimal example: '12.50' - description: >- A stop-limit order. Becomes a limit order at `limit_price` once `stop_price` is reached. type: object required: - kind - stop_price - limit_price properties: kind: type: string enum: - stop_limit example: stop_limit stop_price: description: The price at which the order is triggered. type: string format: decimal example: '12.50' limit_price: description: The limit price that applies once triggered. type: string format: decimal example: '12.34' - description: >- A trailing stop order. The stop price trails the market price by `trail`. type: object required: - kind - trail properties: kind: type: string enum: - trailing_stop example: trailing_stop trail: description: Trail configuration for trailing stop orders. type: object required: - amount - type properties: amount: description: >- The trail amount. Interpreted as dollars if `type` is `DOLLAR`, or a percentage if `type` is `PERCENT`. type: string example: '0.60' type: description: >- Whether the trail `amount` is a dollar amount (`DOLLAR`) or a percentage (`PERCENT`). For example, if `amount` is "0.60" and `type` is `DOLLAR`, the stop price will trail the market price by $0.60. If `amount` is "5" and `type` is `PERCENT`, the stop price will trail the market price by 5%. type: string enum: - DOLLAR - PERCENT stop_price: description: >- The current trigger price, when the brokerage reports it. nullable: true type: string format: decimal example: '20.82' - description: >- A trailing stop-limit order. The stop price trails the market price by `trail`; once triggered, a limit order at `limit_price` is placed. type: object required: - kind - trail - limit_price properties: kind: type: string enum: - trailing_stop_limit example: trailing_stop_limit trail: description: Trail configuration for trailing stop orders. type: object required: - amount - type properties: amount: description: >- The trail amount. Interpreted as dollars if `type` is `DOLLAR`, or a percentage if `type` is `PERCENT`. type: string example: '0.60' type: description: >- Whether the trail `amount` is a dollar amount (`DOLLAR`) or a percentage (`PERCENT`). For example, if `amount` is "0.60" and `type` is `DOLLAR`, the stop price will trail the market price by $0.60. If `amount` is "5" and `type` is `PERCENT`, the stop price will trail the market price by 5%. type: string enum: - DOLLAR - PERCENT limit_price: description: The limit price that applies once triggered. type: string format: decimal example: '12.34' stop_price: description: >- The current trigger price, when the brokerage reports it. nullable: true type: string format: decimal example: '20.82' - description: >- An order type SnapTrade could not normalize, or a recognized type whose required price the brokerage did not report. The brokerage's own label is in `raw_type`. type: object required: - kind - raw_type properties: kind: type: string enum: - other example: other raw_type: description: The order type label as reported by the brokerage. type: string example: MarketIfTouched limit_price: nullable: true type: string format: decimal example: '12.34' stop_price: nullable: true type: string format: decimal example: '12.50' discriminator: propertyName: kind mapping: market: '#/components/schemas/MarketOrderType' limit: '#/components/schemas/LimitOrderType' stop: '#/components/schemas/StopOrderType' stop_limit: '#/components/schemas/StopLimitOrderType' trailing_stop: '#/components/schemas/TrailingStopOrderType' trailing_stop_limit: '#/components/schemas/TrailingStopLimitOrderType' other: '#/components/schemas/OtherOrderType' x-konfig-discriminator-schemas: market: description: A market order. Executes at the best available price. type: object required: - kind properties: kind: type: string enum: - market example: market limit: description: >- A limit order. For multi-leg orders `limit_price` is the net price per spread; see `price_effect` for its direction. type: object required: - kind - limit_price properties: kind: type: string enum: - limit example: limit limit_price: description: >- The maximum price to pay for a buy, or the minimum price to accept for a sell. type: string format: decimal example: '12.34' stop: description: >- A stop order. Becomes a market order once `stop_price` is reached. type: object required: - kind - stop_price properties: kind: type: string enum: - stop example: stop stop_price: description: The price at which the order is triggered. type: string format: decimal example: '12.50' stop_limit: description: >- A stop-limit order. Becomes a limit order at `limit_price` once `stop_price` is reached. type: object required: - kind - stop_price - limit_price properties: kind: type: string enum: - stop_limit example: stop_limit stop_price: description: The price at which the order is triggered. type: string format: decimal example: '12.50' limit_price: description: The limit price that applies once triggered. type: string format: decimal example: '12.34' trailing_stop: description: >- A trailing stop order. The stop price trails the market price by `trail`. type: object required: - kind - trail properties: kind: type: string enum: - trailing_stop example: trailing_stop trail: description: Trail configuration for trailing stop orders. type: object required: - amount - type properties: amount: description: >- The trail amount. Interpreted as dollars if `type` is `DOLLAR`, or a percentage if `type` is `PERCENT`. type: string example: '0.60' type: description: >- Whether the trail `amount` is a dollar amount (`DOLLAR`) or a percentage (`PERCENT`). For example, if `amount` is "0.60" and `type` is `DOLLAR`, the stop price will trail the market price by $0.60. If `amount` is "5" and `type` is `PERCENT`, the stop price will trail the market price by 5%. type: string enum: - DOLLAR - PERCENT stop_price: description: >- The current trigger price, when the brokerage reports it. nullable: true type: string format: decimal example: '20.82' trailing_stop_limit: description: >- A trailing stop-limit order. The stop price trails the market price by `trail`; once triggered, a limit order at `limit_price` is placed. type: object required: - kind - trail - limit_price properties: kind: type: string enum: - trailing_stop_limit example: trailing_stop_limit trail: description: Trail configuration for trailing stop orders. type: object required: - amount - type properties: amount: description: >- The trail amount. Interpreted as dollars if `type` is `DOLLAR`, or a percentage if `type` is `PERCENT`. type: string example: '0.60' type: description: >- Whether the trail `amount` is a dollar amount (`DOLLAR`) or a percentage (`PERCENT`). For example, if `amount` is "0.60" and `type` is `DOLLAR`, the stop price will trail the market price by $0.60. If `amount` is "5" and `type` is `PERCENT`, the stop price will trail the market price by 5%. type: string enum: - DOLLAR - PERCENT limit_price: description: The limit price that applies once triggered. type: string format: decimal example: '12.34' stop_price: description: >- The current trigger price, when the brokerage reports it. nullable: true type: string format: decimal example: '20.82' other: description: >- An order type SnapTrade could not normalize, or a recognized type whose required price the brokerage did not report. The brokerage's own label is in `raw_type`. type: object required: - kind - raw_type properties: kind: type: string enum: - other example: other raw_type: description: The order type label as reported by the brokerage. type: string example: MarketIfTouched limit_price: nullable: true type: string format: decimal example: '12.34' stop_price: nullable: true type: string format: decimal example: '12.50' time_in_force: description: > How long the order remains active. Brokerage values that cannot be mapped to this list are returned as `OTHER`. - `DAY` - valid only for the trading day on which it is placed. - `GTC` - Good Til Canceled. - `FOK` - Fill Or Kill. - `IOC` - Immediate Or Cancel. - `GTD` - Good Til Date; see `expiry_date`. - `MOO` - Market On Open. - `EHP` - Extended Hours P.M. - `EHA` - Extended Hours A.M. - `OTHER` - the brokerage reported a value outside this list. type: string enum: - DAY - GTC - FOK - IOC - GTD - MOO - EHP - EHA - OTHER example: DAY expiry_date: description: >- When the order expires, for orders with a `time_in_force` of `GTD`. nullable: true type: string format: date-time example: '2026-07-30T22:51:49Z' priced_in: description: > The asset the order prices (`execution_price` and the prices inside `order_type`) are denominated in. Use `kind` to determine which schema is present. - `cash` - a fiat currency identified by its ISO-4217 code. This is the case for equities, options, futures, forex and crypto pairs quoted in fiat (for example `USD` for `BTC-USD`). - `crypto` - a crypto asset, for crypto pairs quoted in another crypto asset, including stablecoins (for example `USDC` for `ETH-USDC` or `BTC` for `ETH-BTC`). `null` when the quote asset could not be determined. nullable: true allOf: - description: >- The asset an order's prices are denominated in. Use `kind` to determine which schema is present. oneOf: - description: A fiat currency, identified by its ISO-4217 code. type: object properties: kind: type: string description: Type of security instrument. enum: - cash example: cash code: type: string description: ISO-4217 code of the currency. example: EUR required: - kind - code - description: Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol discriminator: propertyName: kind mapping: cash: '#/components/schemas/CashInstrument' crypto: '#/components/schemas/CryptoInstrument' x-konfig-discriminator-schemas: cash: description: A fiat currency, identified by its ISO-4217 code. type: object properties: kind: type: string description: Type of security instrument. enum: - cash example: cash code: type: string description: ISO-4217 code of the currency. example: EUR required: - kind - code crypto: description: Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol price_effect: description: > Direction of the net order price. CREDIT means cash is received, DEBIT means cash is paid, EVEN means the net price is zero, and UNKNOWN means the direction could not be determined. Null when not applicable, for example for orders containing an outright futures leg (`instrument.kind` of `future`). A futures price is a contract quote, not an upfront cash flow. Futures options retain their price effect. nullable: true allOf: - description: Direction of the net order price when applicable. type: string enum: - CREDIT - DEBIT - EVEN - UNKNOWN total_quantity: description: >- Total quantity requested. For multi-leg orders this is the number of spreads, not the sum of leg quantities. nullable: true type: string format: decimal example: '10' filled_quantity: description: Quantity filled so far. nullable: true type: string format: decimal example: '9' canceled_quantity: description: Quantity canceled. nullable: true type: string format: decimal example: '1' open_quantity: description: Quantity still open (not yet filled or canceled). nullable: true type: string format: decimal example: '0' execution_price: description: >- Average execution price. Per unit for single-leg orders; net price per spread for multi-leg orders. nullable: true type: string format: decimal example: '12.34' time_placed: description: >- The time the order was submitted to the brokerage, when the brokerage reports it. nullable: true type: string format: date-time example: '2026-07-30T22:51:49Z' time_updated: description: >- The time the order was last updated at the brokerage, when available. nullable: true type: string format: date-time example: '2026-07-30T22:52:10Z' time_executed: description: The time the order was executed, when available. nullable: true type: string format: date-time example: '2026-08-05T00:05:57Z' group: description: >- Set when this order belongs to a complex order group (OCO, OTO, OTOCO). Null otherwise. nullable: true allOf: - description: >- Links the orders that make up a complex order (OCO, OTO, OTOCO). type: object required: - id properties: id: description: >- Brokerage-assigned identifier shared by every order in the group. type: string example: '1234567890' role: description: >- This order's role within the group, when the brokerage reports it. nullable: true allOf: - description: >- The role of an order within a complex order group (OCO, OTO, OTOCO). type: string enum: - TRIGGER - CONDITIONAL - PEER example: TRIGGER legs: type: array description: >- The legs that make up the order. Always has at least one entry. minItems: 1 items: description: One leg of an order. type: object required: - instrument - action properties: leg_id: description: >- Brokerage identifier for this leg, when the brokerage assigns one. nullable: true type: string instrument: description: >- Instrument metadata for a V2 position. Use `kind` to determine which schema is present. oneOf: - description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: Option instrument metadata for a V2 position. type: object properties: kind: type: string description: Type of security instrument. enum: - option example: option id: type: string format: uuid description: Unique identifier for the option instrument. example: 899e2697-1d38-4c07-91ee-c16a2b1ce5c9 symbol: type: string description: OCC symbol for the option contract. example: AAPL 261218C00240000 option_type: type: string description: Whether the contract is a call or put. enum: - CALL - PUT example: CALL strike_price: type: string format: decimal description: Strike price for the option contract. example: '240' expiration_date: type: string format: date description: Expiration date of the option contract. example: '2026-12-18' multiplier: type: string format: decimal description: >- Number of underlying shares per contract. Standard options are 100, mini options are 10. example: '100' description: type: string nullable: true description: >- Human-readable description of the option contract. example: AAPL Dec 18 2026 240 CALL underlying: description: The underlying instrument for an option. oneOf: - description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for mutual fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - mutualfund example: mutualfund id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: VFIAX raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: VFIAX description: type: string nullable: true description: >- Human-readable description of the security. example: Vanguard 500 Index Fund Admiral Shares currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for closed-end fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - cef example: cef id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BST raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BST description: type: string nullable: true description: >- Human-readable description of the security. example: BlackRock Science and Technology Trust currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for ADR positions. type: object properties: kind: type: string description: Type of security instrument. enum: - adr example: adr id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BABA raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BABA description: type: string nullable: true description: >- Human-readable description of the security. example: Alibaba Group Holding Ltd ADR currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for preferred stock positions. Preferred shares were previously returned with kind `other`. type: object properties: kind: type: string description: Type of security instrument. enum: - preferred_stock example: preferred_stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: LTSAP raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: LTSAP description: type: string nullable: true description: >- Human-readable description of the security. example: >- Ladenburg Thalmann Financial Services 8% Series A Cumulative Redeemable Preferred Stock currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XASE figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol discriminator: propertyName: kind mapping: stock: '#/components/schemas/StockInstrument' crypto: '#/components/schemas/CryptoInstrument' etf: '#/components/schemas/EtfInstrument' mutualfund: >- #/components/schemas/MutualFundInstrument cef: '#/components/schemas/CefInstrument' adr: '#/components/schemas/AdrInstrument' bond: '#/components/schemas/OtherInstrument' other: '#/components/schemas/OtherInstrument' preferred_stock: >- #/components/schemas/PreferredStockInstrument x-konfig-discriminator-schemas: stock: description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol crypto: description: >- Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol etf: description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol mutualfund: description: >- Security instrument metadata for mutual fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - mutualfund example: mutualfund id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: VFIAX raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: VFIAX description: type: string nullable: true description: >- Human-readable description of the security. example: Vanguard 500 Index Fund Admiral Shares currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol cef: description: >- Security instrument metadata for closed-end fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - cef example: cef id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BST raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BST description: type: string nullable: true description: >- Human-readable description of the security. example: BlackRock Science and Technology Trust currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol adr: description: >- Security instrument metadata for ADR positions. type: object properties: kind: type: string description: Type of security instrument. enum: - adr example: adr id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BABA raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BABA description: type: string nullable: true description: >- Human-readable description of the security. example: Alibaba Group Holding Ltd ADR currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol bond: description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol other: description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol preferred_stock: description: >- Security instrument metadata for preferred stock positions. Preferred shares were previously returned with kind `other`. type: object properties: kind: type: string description: Type of security instrument. enum: - preferred_stock example: preferred_stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: LTSAP raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: LTSAP description: type: string nullable: true description: >- Human-readable description of the security. example: >- Ladenburg Thalmann Financial Services 8% Series A Cumulative Redeemable Preferred Stock currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XASE figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol required: - kind - id - symbol - option_type - strike_price - expiration_date - multiplier - underlying - description: >- Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: Future instrument metadata for a V2 position. type: object properties: kind: type: string description: Type of security instrument. enum: - future example: future id: type: string format: uuid description: Unique identifier for the future instrument. example: 2fef6a3c-4d3f-4a0a-b1fe-8c45a9c7da7f symbol: type: string description: Display symbol for the future contract. example: ESM26 root_symbol: type: string description: Root symbol for the future contract. example: ES expiration_code: type: string description: Exchange expiration code for the contract. example: M26 expiration_date: type: string format: date nullable: true description: Expiration date of the contract. example: '2024-09-20' multiplier: type: string format: decimal nullable: true description: Multiplier for the future contract. example: '50' currency: type: string nullable: true description: ISO-4217 currency code for the contract. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the contract. example: XCME required: - kind - id - symbol - root_symbol - expiration_code - description: > Future option (option on a futures contract) instrument metadata for a V2 position. **Beta:** currently returned only for tastytrade and Interactive Brokers connections, and only for partners it has been enabled for. This schema may change. type: object properties: kind: type: string description: Type of security instrument. enum: - future_option example: future_option id: type: string format: uuid description: >- Unique identifier for the future option instrument. example: 5f1c9a76-2c1e-4bfb-9d18-3a2f0f5b6c41 symbol: type: string description: >- Display symbol for the future option contract. example: ZBZ25 P105 option_type: type: string description: Whether the contract is a call or put. enum: - CALL - PUT example: PUT strike_price: type: string format: decimal description: Strike price for the option contract. example: '105' expiration_date: type: string format: date description: Expiration date of the option contract. example: '2025-11-21' multiplier: type: string format: decimal nullable: true description: Notional multiplier for the option contract. example: '1000' description: type: string nullable: true description: >- Human-readable description of the option contract. example: 30 Year U.S. Treasury Bond Dec 2025 105 PUT currency: type: string nullable: true description: ISO-4217 currency code for the contract. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the contract. example: XCBT underlying: description: >- Future instrument metadata for a V2 position. type: object properties: kind: type: string description: Type of security instrument. enum: - future example: future id: type: string format: uuid description: >- Unique identifier for the future instrument. example: 2fef6a3c-4d3f-4a0a-b1fe-8c45a9c7da7f symbol: type: string description: Display symbol for the future contract. example: ESM26 root_symbol: type: string description: Root symbol for the future contract. example: ES expiration_code: type: string description: >- Exchange expiration code for the contract. example: M26 expiration_date: type: string format: date nullable: true description: Expiration date of the contract. example: '2024-09-20' multiplier: type: string format: decimal nullable: true description: Multiplier for the future contract. example: '50' currency: type: string nullable: true description: ISO-4217 currency code for the contract. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the contract. example: XCME required: - kind - id - symbol - root_symbol - expiration_code required: - kind - id - symbol - option_type - strike_price - expiration_date - underlying - description: Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for mutual fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - mutualfund example: mutualfund id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: VFIAX raw_symbol: type: string description: The raw symbol without any exchange suffix. example: VFIAX description: type: string nullable: true description: Human-readable description of the security. example: Vanguard 500 Index Fund Admiral Shares currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for closed-end fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - cef example: cef id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BST raw_symbol: type: string description: The raw symbol without any exchange suffix. example: BST description: type: string nullable: true description: Human-readable description of the security. example: BlackRock Science and Technology Trust currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: Security instrument metadata for ADR positions. type: object properties: kind: type: string description: Type of security instrument. enum: - adr example: adr id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BABA raw_symbol: type: string description: The raw symbol without any exchange suffix. example: BABA description: type: string nullable: true description: Human-readable description of the security. example: Alibaba Group Holding Ltd ADR currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Canonical CFD wrapper instrument metadata for a V2 position. type: object properties: kind: type: string description: Type of security instrument. enum: - cfd example: cfd id: type: string format: uuid description: >- Unique identifier for the canonical CFD instrument wrapper. example: 8cbb2a60-236e-4b67-9e25-a8cf299839f5 symbol: type: string description: >- Formatted symbol of the instrument underlying the CFD wrapper. example: AAPL raw_symbol: type: string description: >- Raw symbol of the instrument underlying the CFD wrapper. example: AAPL description: type: string nullable: true description: >- Human-readable description of the instrument underlying the CFD wrapper. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the instrument underlying the CFD wrapper. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the instrument underlying the CFD wrapper. example: XNAS underlying_instrument: description: >- The underlying instrument referenced by a CFD contract. oneOf: - description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for mutual fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - mutualfund example: mutualfund id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: VFIAX raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: VFIAX description: type: string nullable: true description: >- Human-readable description of the security. example: Vanguard 500 Index Fund Admiral Shares currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for closed-end fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - cef example: cef id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BST raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BST description: type: string nullable: true description: >- Human-readable description of the security. example: BlackRock Science and Technology Trust currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for ADR positions. type: object properties: kind: type: string description: Type of security instrument. enum: - adr example: adr id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BABA raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BABA description: type: string nullable: true description: >- Human-readable description of the security. example: Alibaba Group Holding Ltd ADR currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for preferred stock positions. Preferred shares were previously returned with kind `other`. type: object properties: kind: type: string description: Type of security instrument. enum: - preferred_stock example: preferred_stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: LTSAP raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: LTSAP description: type: string nullable: true description: >- Human-readable description of the security. example: >- Ladenburg Thalmann Financial Services 8% Series A Cumulative Redeemable Preferred Stock currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XASE figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol discriminator: propertyName: kind mapping: stock: '#/components/schemas/StockInstrument' crypto: '#/components/schemas/CryptoInstrument' etf: '#/components/schemas/EtfInstrument' mutualfund: >- #/components/schemas/MutualFundInstrument cef: '#/components/schemas/CefInstrument' adr: '#/components/schemas/AdrInstrument' bond: '#/components/schemas/OtherInstrument' other: '#/components/schemas/OtherInstrument' preferred_stock: >- #/components/schemas/PreferredStockInstrument x-konfig-discriminator-schemas: stock: description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol crypto: description: >- Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol etf: description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol mutualfund: description: >- Security instrument metadata for mutual fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - mutualfund example: mutualfund id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: VFIAX raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: VFIAX description: type: string nullable: true description: >- Human-readable description of the security. example: Vanguard 500 Index Fund Admiral Shares currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol cef: description: >- Security instrument metadata for closed-end fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - cef example: cef id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BST raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BST description: type: string nullable: true description: >- Human-readable description of the security. example: BlackRock Science and Technology Trust currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol adr: description: >- Security instrument metadata for ADR positions. type: object properties: kind: type: string description: Type of security instrument. enum: - adr example: adr id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BABA raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BABA description: type: string nullable: true description: >- Human-readable description of the security. example: Alibaba Group Holding Ltd ADR currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol bond: description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol other: description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol preferred_stock: description: >- Security instrument metadata for preferred stock positions. Preferred shares were previously returned with kind `other`. type: object properties: kind: type: string description: Type of security instrument. enum: - preferred_stock example: preferred_stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: LTSAP raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: LTSAP description: type: string nullable: true description: >- Human-readable description of the security. example: >- Ladenburg Thalmann Financial Services 8% Series A Cumulative Redeemable Preferred Stock currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XASE figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol required: - kind - id - symbol - raw_symbol - underlying_instrument - description: > Canonical tokenized asset wrapper for a V2 position. Symbol and description duplicate the listed underlying's display metadata for convenience; they are not token-specific identifiers or labels. Currency and exchange metadata are provided only in underlying_instrument. type: object properties: kind: type: string description: Type of security instrument. enum: - tokenized_asset example: tokenized_asset id: type: string format: uuid description: >- Unique identifier for the canonical tokenized asset wrapper. example: 95a57747-46c6-4c9a-a6cc-b79a491fb95a symbol: type: string description: >- Display symbol of the underlying stock or ETF, not a token-specific ticker. example: AAPL description: type: string description: >- Display name of the underlying stock or ETF, when available. example: Apple Inc. underlying_instrument: description: >- The listed stock or ETF underlying a tokenized asset. oneOf: - description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol discriminator: propertyName: kind mapping: stock: '#/components/schemas/StockInstrument' etf: '#/components/schemas/EtfInstrument' x-konfig-discriminator-schemas: stock: description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol etf: description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol required: - kind - id - symbol - underlying_instrument - description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- A fiat currency, identified by its ISO-4217 code. type: object properties: kind: type: string description: Type of security instrument. enum: - cash example: cash code: type: string description: ISO-4217 code of the currency. example: EUR required: - kind - code - description: >- Security instrument metadata for preferred stock positions. Preferred shares were previously returned with kind `other`. type: object properties: kind: type: string description: Type of security instrument. enum: - preferred_stock example: preferred_stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: LTSAP raw_symbol: type: string description: The raw symbol without any exchange suffix. example: LTSAP description: type: string nullable: true description: Human-readable description of the security. example: >- Ladenburg Thalmann Financial Services 8% Series A Cumulative Redeemable Preferred Stock currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XASE figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol discriminator: propertyName: kind mapping: stock: '#/components/schemas/StockInstrument' option: '#/components/schemas/OptionInstrument' crypto: '#/components/schemas/CryptoInstrument' future: '#/components/schemas/FutureInstrument' future_option: '#/components/schemas/FutureOptionInstrument' etf: '#/components/schemas/EtfInstrument' mutualfund: '#/components/schemas/MutualFundInstrument' cef: '#/components/schemas/CefInstrument' adr: '#/components/schemas/AdrInstrument' cfd: '#/components/schemas/CfdInstrument' tokenized_asset: '#/components/schemas/TokenizedAssetInstrument' cash: '#/components/schemas/CashInstrument' bond: '#/components/schemas/OtherInstrument' other: '#/components/schemas/OtherInstrument' preferred_stock: '#/components/schemas/PreferredStockInstrument' x-konfig-discriminator-schemas: stock: description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol option: description: Option instrument metadata for a V2 position. type: object properties: kind: type: string description: Type of security instrument. enum: - option example: option id: type: string format: uuid description: Unique identifier for the option instrument. example: 899e2697-1d38-4c07-91ee-c16a2b1ce5c9 symbol: type: string description: OCC symbol for the option contract. example: AAPL 261218C00240000 option_type: type: string description: Whether the contract is a call or put. enum: - CALL - PUT example: CALL strike_price: type: string format: decimal description: Strike price for the option contract. example: '240' expiration_date: type: string format: date description: Expiration date of the option contract. example: '2026-12-18' multiplier: type: string format: decimal description: >- Number of underlying shares per contract. Standard options are 100, mini options are 10. example: '100' description: type: string nullable: true description: >- Human-readable description of the option contract. example: AAPL Dec 18 2026 240 CALL underlying: description: The underlying instrument for an option. oneOf: - description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for mutual fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - mutualfund example: mutualfund id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: VFIAX raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: VFIAX description: type: string nullable: true description: >- Human-readable description of the security. example: Vanguard 500 Index Fund Admiral Shares currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for closed-end fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - cef example: cef id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BST raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BST description: type: string nullable: true description: >- Human-readable description of the security. example: BlackRock Science and Technology Trust currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for ADR positions. type: object properties: kind: type: string description: Type of security instrument. enum: - adr example: adr id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BABA raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BABA description: type: string nullable: true description: >- Human-readable description of the security. example: Alibaba Group Holding Ltd ADR currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for preferred stock positions. Preferred shares were previously returned with kind `other`. type: object properties: kind: type: string description: Type of security instrument. enum: - preferred_stock example: preferred_stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: LTSAP raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: LTSAP description: type: string nullable: true description: >- Human-readable description of the security. example: >- Ladenburg Thalmann Financial Services 8% Series A Cumulative Redeemable Preferred Stock currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XASE figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol discriminator: propertyName: kind mapping: stock: '#/components/schemas/StockInstrument' crypto: '#/components/schemas/CryptoInstrument' etf: '#/components/schemas/EtfInstrument' mutualfund: >- #/components/schemas/MutualFundInstrument cef: '#/components/schemas/CefInstrument' adr: '#/components/schemas/AdrInstrument' bond: '#/components/schemas/OtherInstrument' other: '#/components/schemas/OtherInstrument' preferred_stock: >- #/components/schemas/PreferredStockInstrument x-konfig-discriminator-schemas: stock: description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol crypto: description: >- Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol etf: description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol mutualfund: description: >- Security instrument metadata for mutual fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - mutualfund example: mutualfund id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: VFIAX raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: VFIAX description: type: string nullable: true description: >- Human-readable description of the security. example: Vanguard 500 Index Fund Admiral Shares currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol cef: description: >- Security instrument metadata for closed-end fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - cef example: cef id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BST raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BST description: type: string nullable: true description: >- Human-readable description of the security. example: BlackRock Science and Technology Trust currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol adr: description: >- Security instrument metadata for ADR positions. type: object properties: kind: type: string description: Type of security instrument. enum: - adr example: adr id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BABA raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BABA description: type: string nullable: true description: >- Human-readable description of the security. example: Alibaba Group Holding Ltd ADR currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol bond: description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol other: description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol preferred_stock: description: >- Security instrument metadata for preferred stock positions. Preferred shares were previously returned with kind `other`. type: object properties: kind: type: string description: Type of security instrument. enum: - preferred_stock example: preferred_stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: LTSAP raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: LTSAP description: type: string nullable: true description: >- Human-readable description of the security. example: >- Ladenburg Thalmann Financial Services 8% Series A Cumulative Redeemable Preferred Stock currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XASE figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol required: - kind - id - symbol - option_type - strike_price - expiration_date - multiplier - underlying crypto: description: >- Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol future: description: Future instrument metadata for a V2 position. type: object properties: kind: type: string description: Type of security instrument. enum: - future example: future id: type: string format: uuid description: Unique identifier for the future instrument. example: 2fef6a3c-4d3f-4a0a-b1fe-8c45a9c7da7f symbol: type: string description: Display symbol for the future contract. example: ESM26 root_symbol: type: string description: Root symbol for the future contract. example: ES expiration_code: type: string description: Exchange expiration code for the contract. example: M26 expiration_date: type: string format: date nullable: true description: Expiration date of the contract. example: '2024-09-20' multiplier: type: string format: decimal nullable: true description: Multiplier for the future contract. example: '50' currency: type: string nullable: true description: ISO-4217 currency code for the contract. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the contract. example: XCME required: - kind - id - symbol - root_symbol - expiration_code future_option: description: > Future option (option on a futures contract) instrument metadata for a V2 position. **Beta:** currently returned only for tastytrade and Interactive Brokers connections, and only for partners it has been enabled for. This schema may change. type: object properties: kind: type: string description: Type of security instrument. enum: - future_option example: future_option id: type: string format: uuid description: >- Unique identifier for the future option instrument. example: 5f1c9a76-2c1e-4bfb-9d18-3a2f0f5b6c41 symbol: type: string description: >- Display symbol for the future option contract. example: ZBZ25 P105 option_type: type: string description: Whether the contract is a call or put. enum: - CALL - PUT example: PUT strike_price: type: string format: decimal description: Strike price for the option contract. example: '105' expiration_date: type: string format: date description: Expiration date of the option contract. example: '2025-11-21' multiplier: type: string format: decimal nullable: true description: Notional multiplier for the option contract. example: '1000' description: type: string nullable: true description: >- Human-readable description of the option contract. example: 30 Year U.S. Treasury Bond Dec 2025 105 PUT currency: type: string nullable: true description: ISO-4217 currency code for the contract. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the contract. example: XCBT underlying: description: >- Future instrument metadata for a V2 position. type: object properties: kind: type: string description: Type of security instrument. enum: - future example: future id: type: string format: uuid description: >- Unique identifier for the future instrument. example: 2fef6a3c-4d3f-4a0a-b1fe-8c45a9c7da7f symbol: type: string description: Display symbol for the future contract. example: ESM26 root_symbol: type: string description: Root symbol for the future contract. example: ES expiration_code: type: string description: >- Exchange expiration code for the contract. example: M26 expiration_date: type: string format: date nullable: true description: Expiration date of the contract. example: '2024-09-20' multiplier: type: string format: decimal nullable: true description: Multiplier for the future contract. example: '50' currency: type: string nullable: true description: ISO-4217 currency code for the contract. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the contract. example: XCME required: - kind - id - symbol - root_symbol - expiration_code required: - kind - id - symbol - option_type - strike_price - expiration_date - underlying etf: description: Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol mutualfund: description: >- Security instrument metadata for mutual fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - mutualfund example: mutualfund id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: VFIAX raw_symbol: type: string description: The raw symbol without any exchange suffix. example: VFIAX description: type: string nullable: true description: Human-readable description of the security. example: Vanguard 500 Index Fund Admiral Shares currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol cef: description: >- Security instrument metadata for closed-end fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - cef example: cef id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BST raw_symbol: type: string description: The raw symbol without any exchange suffix. example: BST description: type: string nullable: true description: Human-readable description of the security. example: BlackRock Science and Technology Trust currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol adr: description: Security instrument metadata for ADR positions. type: object properties: kind: type: string description: Type of security instrument. enum: - adr example: adr id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BABA raw_symbol: type: string description: The raw symbol without any exchange suffix. example: BABA description: type: string nullable: true description: Human-readable description of the security. example: Alibaba Group Holding Ltd ADR currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol cfd: description: >- Canonical CFD wrapper instrument metadata for a V2 position. type: object properties: kind: type: string description: Type of security instrument. enum: - cfd example: cfd id: type: string format: uuid description: >- Unique identifier for the canonical CFD instrument wrapper. example: 8cbb2a60-236e-4b67-9e25-a8cf299839f5 symbol: type: string description: >- Formatted symbol of the instrument underlying the CFD wrapper. example: AAPL raw_symbol: type: string description: >- Raw symbol of the instrument underlying the CFD wrapper. example: AAPL description: type: string nullable: true description: >- Human-readable description of the instrument underlying the CFD wrapper. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the instrument underlying the CFD wrapper. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the instrument underlying the CFD wrapper. example: XNAS underlying_instrument: description: >- The underlying instrument referenced by a CFD contract. oneOf: - description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for mutual fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - mutualfund example: mutualfund id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: VFIAX raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: VFIAX description: type: string nullable: true description: >- Human-readable description of the security. example: Vanguard 500 Index Fund Admiral Shares currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for closed-end fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - cef example: cef id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BST raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BST description: type: string nullable: true description: >- Human-readable description of the security. example: BlackRock Science and Technology Trust currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for ADR positions. type: object properties: kind: type: string description: Type of security instrument. enum: - adr example: adr id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BABA raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BABA description: type: string nullable: true description: >- Human-readable description of the security. example: Alibaba Group Holding Ltd ADR currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for preferred stock positions. Preferred shares were previously returned with kind `other`. type: object properties: kind: type: string description: Type of security instrument. enum: - preferred_stock example: preferred_stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: LTSAP raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: LTSAP description: type: string nullable: true description: >- Human-readable description of the security. example: >- Ladenburg Thalmann Financial Services 8% Series A Cumulative Redeemable Preferred Stock currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XASE figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol discriminator: propertyName: kind mapping: stock: '#/components/schemas/StockInstrument' crypto: '#/components/schemas/CryptoInstrument' etf: '#/components/schemas/EtfInstrument' mutualfund: >- #/components/schemas/MutualFundInstrument cef: '#/components/schemas/CefInstrument' adr: '#/components/schemas/AdrInstrument' bond: '#/components/schemas/OtherInstrument' other: '#/components/schemas/OtherInstrument' preferred_stock: >- #/components/schemas/PreferredStockInstrument x-konfig-discriminator-schemas: stock: description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol crypto: description: >- Security instrument metadata for crypto positions. type: object properties: kind: type: string description: Type of security instrument. enum: - crypto example: crypto id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true deprecated: true description: >- Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version. figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol etf: description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol mutualfund: description: >- Security instrument metadata for mutual fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - mutualfund example: mutualfund id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: VFIAX raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: VFIAX description: type: string nullable: true description: >- Human-readable description of the security. example: Vanguard 500 Index Fund Admiral Shares currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol cef: description: >- Security instrument metadata for closed-end fund positions. type: object properties: kind: type: string description: Type of security instrument. enum: - cef example: cef id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BST raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BST description: type: string nullable: true description: >- Human-readable description of the security. example: BlackRock Science and Technology Trust currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol adr: description: >- Security instrument metadata for ADR positions. type: object properties: kind: type: string description: Type of security instrument. enum: - adr example: adr id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: BABA raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: BABA description: type: string nullable: true description: >- Human-readable description of the security. example: Alibaba Group Holding Ltd ADR currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNYS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol bond: description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol other: description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol preferred_stock: description: >- Security instrument metadata for preferred stock positions. Preferred shares were previously returned with kind `other`. type: object properties: kind: type: string description: Type of security instrument. enum: - preferred_stock example: preferred_stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: LTSAP raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: LTSAP description: type: string nullable: true description: >- Human-readable description of the security. example: >- Ladenburg Thalmann Financial Services 8% Series A Cumulative Redeemable Preferred Stock currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XASE figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol required: - kind - id - symbol - raw_symbol - underlying_instrument tokenized_asset: description: > Canonical tokenized asset wrapper for a V2 position. Symbol and description duplicate the listed underlying's display metadata for convenience; they are not token-specific identifiers or labels. Currency and exchange metadata are provided only in underlying_instrument. type: object properties: kind: type: string description: Type of security instrument. enum: - tokenized_asset example: tokenized_asset id: type: string format: uuid description: >- Unique identifier for the canonical tokenized asset wrapper. example: 95a57747-46c6-4c9a-a6cc-b79a491fb95a symbol: type: string description: >- Display symbol of the underlying stock or ETF, not a token-specific ticker. example: AAPL description: type: string description: >- Display name of the underlying stock or ETF, when available. example: Apple Inc. underlying_instrument: description: >- The listed stock or ETF underlying a tokenized asset. oneOf: - description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol - description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol discriminator: propertyName: kind mapping: stock: '#/components/schemas/StockInstrument' etf: '#/components/schemas/EtfInstrument' x-konfig-discriminator-schemas: stock: description: >- Security instrument metadata for stock positions. type: object properties: kind: type: string description: Type of security instrument. enum: - stock example: stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol etf: description: >- Security instrument metadata for ETF positions. type: object properties: kind: type: string description: Type of security instrument. enum: - etf example: etf id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: >- The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: >- Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol required: - kind - id - symbol - underlying_instrument cash: description: >- A fiat currency, identified by its ISO-4217 code. type: object properties: kind: type: string description: Type of security instrument. enum: - cash example: cash code: type: string description: ISO-4217 code of the currency. example: EUR required: - kind - code bond: description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol other: description: >- Security instrument metadata for bonds and other mapped security positions. type: object properties: kind: type: string description: Type of security instrument. enum: - bond - other example: other id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: AAPL raw_symbol: type: string description: The raw symbol without any exchange suffix. example: AAPL description: type: string nullable: true description: Human-readable description of the security. example: Apple Inc. currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XNAS figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol preferred_stock: description: >- Security instrument metadata for preferred stock positions. Preferred shares were previously returned with kind `other`. type: object properties: kind: type: string description: Type of security instrument. enum: - preferred_stock example: preferred_stock id: type: string format: uuid description: Unique identifier for the instrument. example: 1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324 symbol: type: string description: >- The formatted trading symbol for the security. example: LTSAP raw_symbol: type: string description: The raw symbol without any exchange suffix. example: LTSAP description: type: string nullable: true description: Human-readable description of the security. example: >- Ladenburg Thalmann Financial Services 8% Series A Cumulative Redeemable Preferred Stock currency: type: string nullable: true description: >- ISO-4217 currency code for the security listing. example: USD exchange: type: string nullable: true description: >- Exchange MIC code or exchange code for the security. example: XASE figi_instrument: nullable: true allOf: - description: >- Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. type: object properties: figi_code: description: >- This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG000B9Y5X2 nullable: true figi_share_class: description: >- This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. type: string example: BBG001S5N8V8 nullable: true required: - kind - id - symbol - raw_symbol action: type: string description: | The action describes the intent or side of a trade. - BUY - SELL - BUY_COVER - SELL_SHORT - BUY_TO_OPEN - BUY_TO_CLOSE - SELL_TO_OPEN - SELL_TO_CLOSE total_quantity: description: >- Total number of shares or contracts for this leg. Can be a decimal for fractional orders. nullable: true type: string format: decimal example: '10' filled_quantity: description: Number of shares or contracts filled for this leg. nullable: true type: string format: decimal example: '9' canceled_quantity: description: Number of shares or contracts canceled for this leg. nullable: true type: string format: decimal example: '1' execution_price: description: >- Average execution price for this leg, when available. nullable: true type: string format: decimal example: '12.34' status: nullable: true allOf: - description: >- Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. type: string enum: - PENDING - REJECTED - CANCELED - CANCEL_PENDING - PARTIAL_CANCELED - EXECUTED - PARTIALLY_EXECUTED - REPLACED - REPLACE_PENDING - EXPIRED '403': description: Forbidden content: application/json: schema: description: Example for failed request response type: object properties: detail: example: >- Feature is not enabled for this customer or this connection default_code: example: 1141 '404': description: Not Found content: application/json: schema: description: Example for failed request response type: object properties: default_detail: example: The requested resource does not exist. default_code: example: 1011 '429': description: > Rate limit exceeded. Check `X-RateLimit-Remaining` (customer-level) and `X-RateLimit-Account-Remaining` (account-level) to see which limit you hit, then wait for the matching `*-Reset` value before retrying. Not every header listed below appears on every operation. The `X-RateLimit-Account-*` headers are sent only where the per-account limit is enforced, and OAuth-authenticated requests never receive the customer-level `X-RateLimit-Limit`, `X-RateLimit-Remaining` or `X-RateLimit-Reset`. A separate per-authenticated-user limit, reported in no `X-RateLimit-*` header, covers OAuth-authenticated requests and signed requests not governed by the customer-level limit; it does not stack on top of that limit. So a 429 can arrive with every reported counter above zero — or with no `X-RateLimit-*` headers at all. Honour `Retry-After` in that case. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer example: 7 X-RateLimit-Limit: description: Customer-level request allowance for the current window. schema: type: integer example: 250 X-RateLimit-Remaining: description: >- Customer-level requests left in the current window. 0 on a 429 means this is the limit you hit. schema: type: integer example: 249 X-RateLimit-Reset: description: Seconds until the customer-level window resets. schema: type: integer example: 60 X-RateLimit-Account-Limit: description: >- Per-account request allowance for the current window. Only sent on account-data endpoints where the account-level limit applies. schema: type: integer example: 10 X-RateLimit-Account-Remaining: description: >- Per-account requests left in the current window. 0 on a 429 means this is the limit you hit. schema: type: integer example: 9 X-RateLimit-Account-Reset: description: Seconds until the per-account window resets. schema: type: integer example: 60 content: application/json: schema: description: Example for a rate-limited request response type: object properties: detail: example: Connection refreshed too recently. Please try again later. status_code: example: 429 code: example: throttled '500': description: Unexpected error content: application/json: schema: description: Example for a response that failed for unexpected reasons type: object properties: detail: example: Encountered an unexpected exception. status_code: example: 500 code: example: 1000 '501': description: Not Implemented - order details are not supported for this brokerage content: application/json: schema: description: >- Example for a response where the endpoint is not implemented for the brokerage type: object properties: error: example: >- The orders endpoint is not yet implemented for brokerage some-brokerage '503': description: >- Service Unavailable - the brokerage connection is busy syncing (sync lock held) or the brokerage API is temporarily unavailable. Safe to retry. content: application/json: schema: description: >- Example for a response that failed because of an upstream brokerage API failure type: object properties: detail: example: >- Unable to sync with brokerage account. Invalid response from Brokerage API. status_code: example: 503 code: example: 3002 security: - PartnerSignature: [] PartnerClientId: [] PartnerTimestamp: [] userId: [] userSecret: [] - PersonalSignature: [] PersonalClientId: [] PersonalTimestamp: [] ```