# Table of Contents - [Get API Status / SnapTrade](#get-api-status-snaptrade) - [Register user / SnapTrade](#register-user-snaptrade) - [List all users / SnapTrade](#list-all-users-snaptrade) - [Generate Connection Portal URL / SnapTrade](#generate-connection-portal-url-snaptrade) - [Rotate user secret / SnapTrade](#rotate-user-secret-snaptrade) - [Delete user / SnapTrade](#delete-user-snaptrade) - [Delete connection / SnapTrade](#delete-connection-snaptrade) - [Force disable connection / SnapTrade](#force-disable-connection-snaptrade) - [List all connections / SnapTrade](#list-all-connections-snaptrade) - [Refresh holdings for a connection / SnapTrade](#refresh-holdings-for-a-connection-snaptrade) - [Get connection detail / SnapTrade](#get-connection-detail-snaptrade) - [List accounts / SnapTrade](#list-accounts-snaptrade) - [Get account detail / SnapTrade](#get-account-detail-snaptrade) - [List account balances / SnapTrade](#list-account-balances-snaptrade) - [Get equity symbol quotes / SnapTrade](#get-equity-symbol-quotes-snaptrade) - [List account positions / SnapTrade](#list-account-positions-snaptrade) - [Get crypto pairs / SnapTrade](#get-crypto-pairs-snaptrade) - [List account option positions / SnapTrade](#list-account-option-positions-snaptrade) - [Get crypto pair quote / SnapTrade](#get-crypto-pair-quote-snaptrade) - [Preview crypto order / SnapTrade](#preview-crypto-order-snaptrade) - [Cancel order / SnapTrade](#cancel-order-snaptrade) - [Check equity order impact / SnapTrade](#check-equity-order-impact-snaptrade) - [List account holdings / SnapTrade](#list-account-holdings-snaptrade) - [Get brokerage instruments / SnapTrade](#get-brokerage-instruments-snaptrade) - [List account activities / SnapTrade](#list-account-activities-snaptrade) - [Get Client Info / SnapTrade](#get-client-info-snaptrade) - [Search account symbols / SnapTrade](#search-account-symbols-snaptrade) - [List security types / SnapTrade](#list-security-types-snaptrade) - [Get symbol detail / SnapTrade](#get-symbol-detail-snaptrade) - [List account recent orders (last 24 hours only) / SnapTrade](#list-account-recent-orders-last-24-hours-only-snaptrade) - [List account orders / SnapTrade](#list-account-orders-snaptrade) - [Search symbols / SnapTrade](#search-symbols-snaptrade) - [Place checked equity order / SnapTrade](#place-checked-equity-order-snaptrade) - [Place option order / SnapTrade](#place-option-order-snaptrade) - [Place order / SnapTrade](#place-order-snaptrade) - [Place bracket order / SnapTrade](#place-bracket-order-snaptrade) - [Place crypto order / SnapTrade](#place-crypto-order-snaptrade) - [Replace order / SnapTrade](#replace-order-snaptrade) --- # Get API Status / SnapTrade API Status Get API Status -------------- get `https://api.snaptrade.com/api/v1/` Check whether the API is operational and verify timestamps. #### Execute an API Request No request parameters. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `object` Status of API `version``integer` `timestamp``string` `online``boolean` 1 { 2 "version": 153, 3 "timestamp": "2022-11-04T01:47:00.377Z", 4 "online": true 5 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Register user / SnapTrade Authentication Register user ------------- post `https://api.snaptrade.com/api/v1/snapTrade/registerUser` Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters. #### Execute an API Request Request Body `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400404500 `object` `userId``string` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . 1 { 2 "userId": "snaptrade-user-123", 3 "userSecret": "adf2aa34-8219-40f7-a6b3-60156985cc61" 4 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # List all users / SnapTrade Authentication List all users -------------- get `https://api.snaptrade.com/api/v1/snapTrade/listUsers` Returns a list of all registered user IDs. Please note that the response is not currently paginated. #### Execute an API Request No request parameters. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400404500 `array of strings` List of registered SnapTrade user IDs `string` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. 1 \[\ \ 2\ \ "user1",\ \ 3\ \ "user2",\ \ 4\ \ "user3"\ \ 5\ \ \] [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Generate Connection Portal URL / SnapTrade Authentication Generate Connection Portal URL ------------------------------ post `https://api.snaptrade.com/api/v1/snapTrade/login` Authenticates a SnapTrade user and returns the Connection Portal URL used for connecting brokerage accounts. Please check [this guide](https://docs.snaptrade.com/docs/implement-connection-portal) for how to integrate the Connection Portal into your app. Please note that the returned URL expires in 5 minutes. #### Execute an API Request Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Request Body `broker``string` Slug of the brokerage to connect the user to. See [the integrations page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=3cfea70ef4254afc89704e47275a7a9a&pvs=4) for a list of supported brokerages and their slugs. `immediateRedirect``boolean` When set to `true`, user will be redirected back to the partner's site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information. Unset False True `customRedirect``string` URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information. `reconnect``string` The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](https://docs.snaptrade.com/docs/fix-broken-connections) for more information. `connectionType``string` Determines connection permissions (default: read) - `read`: Data access only. - `trade`: Data and trading access. - `trade-if-available`: Attempts to establish a trading connection if the brokerage supports it, otherwise falls back to read-only access automatically. `connectionPortalVersion``string` Sets the connection portal version to render. Currently only v4 is supported and is the default. All other versions are deprecated and will automatically be set to v4. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400403404500 Schema 1Schema 2 `object` Redirect uri upon successful login `redirectURI``string` Connection Portal link to redirect user to connect a brokerage account. `sessionId``string` ID to identify the connection portal session. 1 { 2 "redirectURI": "https://app.snaptrade.com/snapTrade/redeemToken?token=npVKchZrL0MYIHTusGfADT74r4xXpHkmbxbQDmt0RINLXbQ5cWsvGkPSgMQRxz8/cnxjzL9T2NWLuHuDyidHiCNeXXTb/tVhzC2olSyfxWW6DRrkUppArGCdmkIHyBMzog6C55P8yoqzcGer5Hml0Q%3D%3D&clientId=WEALTHLY&broker=ROBINHOOD&connectionPortalVersion=v4&sessionId=cf371bb4-a475-4f17-ab94-d0fee699960d", 3 "sessionId": "cf371bb4-a475-4f17-ab94-d0fee699960d" 4 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Rotate user secret / SnapTrade Authentication Rotate user secret ------------------ post `https://api.snaptrade.com/api/v1/snapTrade/resetUserSecret` Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect. #### Execute an API Request Request Body `userId``string` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400401500 `object` `userId``string` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . 1 { 2 "userId": "snaptrade-user-123", 3 "userSecret": "adf2aa34-8219-40f7-a6b3-60156985cc61" 4 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Delete user / SnapTrade Authentication Delete user ----------- delete `https://api.snaptrade.com/api/v1/snapTrade/deleteUser` Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent. #### Execute an API Request Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400403404500 `object` `status``string` This is always `deleted` when a user is queued for deletion. `detail``string` Human friendly message about the deletion status. `userId``string` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. 1 { 2 "status": "deleted", 3 "detail": "User queued for deletion; please wait for webhook for confirmation.", 4 "userId": "snaptrade-user-123" 5 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Delete connection / SnapTrade Connections Delete connection ----------------- delete `https://api.snaptrade.com/api/v1/authorizations/{authorizationId}` Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted. #### Execute an API Request Path `authorizationId``string (format: uuid)``required` Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 204400404default No response fields. [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Force disable connection / SnapTrade Connections Force disable connection ------------------------ post `https://api.snaptrade.com/api/v1/authorizations/{authorizationId}/disable` Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection. This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default. #### Execute an API Request Path `authorizationId``string (format: uuid)``required` Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200401402403404 `object` Confirmation that the connection has been disabled. `detail``string` Connection disabled confirmation 1 { 2 "detail": "Connection 0b3ebefb-ed47-43df-cd8f-729a4420b5cf has been disabled" 3 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # List all connections / SnapTrade Connections List all connections -------------------- get `https://api.snaptrade.com/api/v1/authorizations` Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency. A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts. SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one. #### Execute an API Request Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `array of objects` A list of all connections for the specified user. Expand all... `object` A single connection with a brokerage. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency. A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts. SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one. Show properties `id``string (format: uuid)` Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade. `created_date``string (format: date-time)` Timestamp of when the connection was established in SnapTrade. `brokerage``object` Describes a brokerage that SnapTrade supports. Show properties `id``string (format: uuid)` Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade. `slug``string` A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change. `name``string` Full name of the brokerage. `display_name``string` A display-friendly name of the brokerage. `description``string` A brief description of the brokerage. `aws_s3_logo_url``string (format: url)` URL to the brokerage's logo. `aws_s3_square_logo_url``string (format: url) or null` URL to the brokerage's logo in square format. `url``string (format: url)` URL to the brokerage's website. `enabled``boolean` Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections. `maintenance_mode``boolean` Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections. `allows_trading``boolean or null` Whether the brokerage allows trading through SnapTrade. `allows_fractional_units``boolean or null` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `has_reporting``boolean or null` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `is_real_time_connection``boolean` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `brokerage_type``object` Type of brokerage. Currently supports traditional brokerages and crypto exchanges. Show properties `id``string (format: uuid)` `name``string` `exchanges``array of any` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `open_url``string (format: url) or null` Deprecated Refrain from usage of this field This field is deprecated. `name``string` A short, human-readable name for the connection. `type``string` Whether the connection is read-only or trade-enabled. A read-only connection can only be used to fetch data, while a trade-enabled connection can be used to place trades. Valid values are `read` and `trade`. `disabled``boolean` Whether the connection is disabled. A disabled connection can no longer access the latest data from the brokerage, but will continue to return the last cached state. A connection can become disabled for many reasons and differs by brokerage. Here are some common scenarios: * The user has changed their username or password at the brokerage. * The user has explicitly removed the access grant at the brokerage. * The session has expired at the brokerage and now requires explicit user re-authentication. Please see [this guide](https://docs.snaptrade.com/docs/fix-broken-connections) on how to fix a disabled connection. `disabled_date``string (format: date-time) or null` Timestamp of when the connection was disabled in SnapTrade. `meta``object` Deprecated Refrain from usage of this field Additional data about the connection. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version. `updated_date``string (format: date-time)` Deprecated Refrain from usage of this field Timestamp of when the connection was last updated in SnapTrade. This field is deprecated. Please let us know if you have a valid use case for this field. `is_eligible_for_payout``boolean` Whether the connection is eligible for a payout. 1 \[\ \ 2\ \ {\ \ 3\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 4\ \ "created\_date": "2024-08-20T21:56:19.123Z",\ \ 5\ \ "brokerage": {\ \ 6\ \ "id": "ebf91a5b-0920-4266-9e36-f6cfe8c40946",\ \ 7\ \ "slug": "ROBINHOOD",\ \ 8\ \ "name": "Robinhood",\ \ 9\ \ "display\_name": "Robinhood",\ \ 10\ \ "description": "Robinhood is an American multinational financial services corporation based in Menlo Park, California.",\ \ 11\ \ "aws\_s3\_logo\_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo.png",\ \ 12\ \ "aws\_s3\_square\_logo\_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo-square.png",\ \ 13\ \ "url": "https://robinhood.com",\ \ 14\ \ "enabled": true,\ \ 15\ \ "maintenance\_mode": true,\ \ 16\ \ "allows\_trading": true,\ \ 17\ \ "allows\_fractional\_units": true,\ \ 18\ \ "has\_reporting": true,\ \ 19\ \ "is\_real\_time\_connection": true,\ \ 20\ \ "brokerage\_type": {\ \ 21\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 22\ \ "name": "Traditional Brokerage"\ \ 23\ \ },\ \ 24\ \ "exchanges": \[\ \ 25\ \ "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 26\ \ "4bcd8cc3-c122-4974-dc21-1858296801f4"\ \ 27\ \ \],\ \ 28\ \ "open\_url": "string"\ \ 29\ \ },\ \ 30\ \ "name": "Connection-1",\ \ 31\ \ "type": "trade",\ \ 32\ \ "disabled": false,\ \ 33\ \ "disabled\_date": "2022-01-21T20:11:19.217Z",\ \ 34\ \ "meta": {\ \ 35\ \ "identifier": 123456\ \ 36\ \ },\ \ 37\ \ "updated\_date": "2024-08-20T21:56:20.057Z",\ \ 38\ \ "is\_eligible\_for\_payout": true\ \ 39\ \ }\ \ 40\ \ \] [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Refresh holdings for a connection / SnapTrade Connections Refresh holdings for a connection --------------------------------- post `https://api.snaptrade.com/api/v1/authorizations/{authorizationId}/refresh` Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Please contact support before use. Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) ** #### Execute an API Request Path `authorizationId``string (format: uuid)``required` Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200401402403404 `object` Confirmation that the syncs have been scheduled. `detail``string` Refresh confirmation details 1 { 2 "detail": "Connection 0b3ebefb-ed47-43df-cd8f-729a4420b5cf scheduled for refresh" 3 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Get connection detail / SnapTrade Connections Get connection detail --------------------- get `https://api.snaptrade.com/api/v1/authorizations/{authorizationId}` Returns a single connection for the specified ID. #### Execute an API Request Path `authorizationId``string (format: uuid)``required` Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `object` A single connection with a brokerage. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency. A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts. SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one. Expand all... `id``string (format: uuid)` Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade. `created_date``string (format: date-time)` Timestamp of when the connection was established in SnapTrade. `brokerage``object` Describes a brokerage that SnapTrade supports. Show properties `id``string (format: uuid)` Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade. `slug``string` A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change. `name``string` Full name of the brokerage. `display_name``string` A display-friendly name of the brokerage. `description``string` A brief description of the brokerage. `aws_s3_logo_url``string (format: url)` URL to the brokerage's logo. `aws_s3_square_logo_url``string (format: url) or null` URL to the brokerage's logo in square format. `url``string (format: url)` URL to the brokerage's website. `enabled``boolean` Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections. `maintenance_mode``boolean` Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections. `allows_trading``boolean or null` Whether the brokerage allows trading through SnapTrade. `allows_fractional_units``boolean or null` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `has_reporting``boolean or null` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `is_real_time_connection``boolean` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `brokerage_type``object` Type of brokerage. Currently supports traditional brokerages and crypto exchanges. Show properties `id``string (format: uuid)` `name``string` `exchanges``array of any` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `open_url``string (format: url) or null` Deprecated Refrain from usage of this field This field is deprecated. `name``string` A short, human-readable name for the connection. `type``string` Whether the connection is read-only or trade-enabled. A read-only connection can only be used to fetch data, while a trade-enabled connection can be used to place trades. Valid values are `read` and `trade`. `disabled``boolean` Whether the connection is disabled. A disabled connection can no longer access the latest data from the brokerage, but will continue to return the last cached state. A connection can become disabled for many reasons and differs by brokerage. Here are some common scenarios: * The user has changed their username or password at the brokerage. * The user has explicitly removed the access grant at the brokerage. * The session has expired at the brokerage and now requires explicit user re-authentication. Please see [this guide](https://docs.snaptrade.com/docs/fix-broken-connections) on how to fix a disabled connection. `disabled_date``string (format: date-time) or null` Timestamp of when the connection was disabled in SnapTrade. `meta``object` Deprecated Refrain from usage of this field Additional data about the connection. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version. `updated_date``string (format: date-time)` Deprecated Refrain from usage of this field Timestamp of when the connection was last updated in SnapTrade. This field is deprecated. Please let us know if you have a valid use case for this field. `is_eligible_for_payout``boolean` Whether the connection is eligible for a payout. 1 { 2 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 3 "created\_date": "2024-08-20T21:56:19.123Z", 4 "brokerage": { 5 "id": "ebf91a5b-0920-4266-9e36-f6cfe8c40946", 6 "slug": "ROBINHOOD", 7 "name": "Robinhood", 8 "display\_name": "Robinhood", 9 "description": "Robinhood is an American multinational financial services corporation based in Menlo Park, California.", 10 "aws\_s3\_logo\_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo.png", 11 "aws\_s3\_square\_logo\_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo-square.png", 12 "url": "https://robinhood.com", 13 "enabled": true, 14 "maintenance\_mode": true, 15 "allows\_trading": true, 16 "allows\_fractional\_units": true, 17 "has\_reporting": true, 18 "is\_real\_time\_connection": true, 19 "brokerage\_type": { 20 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 21 "name": "Traditional Brokerage" 22 }, 23 "exchanges": \[\ \ 24\ \ "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 25\ \ "4bcd8cc3-c122-4974-dc21-1858296801f4"\ \ 26\ \ \], 27 "open\_url": "string" 28 }, 29 "name": "Connection-1", 30 "type": "trade", 31 "disabled": false, 32 "disabled\_date": "2022-01-21T20:11:19.217Z", 33 "meta": { 34 "identifier": 123456 35 }, 36 "updated\_date": "2024-08-20T21:56:20.057Z", 37 "is\_eligible\_for\_payout": true 38 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # List accounts / SnapTrade Account Information List accounts ------------- get `https://api.snaptrade.com/api/v1/accounts` Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. #### Execute an API Request Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `array of objects` List of brokerage accounts across all connections. Expand all... `object` A single account at a brokerage. Show properties `id``string (format: uuid)` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated. `brokerage_authorization``string (format: uuid)` Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade. `name``string or null` A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity. `number``string` The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons. `institution_name``string` The name of the brokerage that holds the account. `created_date``string (format: date-time)` Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the brokerage. `sync_status``object` Contains status update for the account sync process between SnapTrade and the brokerage. Show properties `transactions``object` Status of account transaction sync. SnapTrade syncs transactions from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all transactions from the brokerage account as far back as the brokerage allows. Check [our integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=6fab8012ade6441fa0c6d9af9c55ce3a) for details on how far back we sync for each brokerage. 2. Daily sync - Once a day SnapTrade syncs new transactions from the brokerage. 3. Manual sync - You can retrigger an incremental sync of transactions with the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. Show properties `initial_sync_completed``boolean` Indicates if the initial sync of transactions has been completed. For accounts with a large number of transactions, the initial sync may take a while to complete. `last_successful_sync``string (format: date) or null` All transactions up to this date have been successfully synced. Please note that this is not the date of the last transaction, nor the last time SnapTrade attempted to sync transactions. `first_transaction_date``string (format: date) or null` The date of the first transaction in the account known to SnapTrade. It's possible that the account has transactions before this date, but they are not known to SnapTrade. `holdings``object` Status of account holdings sync. SnapTrade syncs holdings from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all holdings (positions, balances, recent orders, and transactions) immediately after the connection is established. 2. Daily sync - Once a day SnapTrade refreshes all holdings from the brokerage. 3. Manual sync - You can trigger a refresh of holdings with the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. Show properties `initial_sync_completed``boolean` Indicates if the initial sync of holdings has been completed. For accounts with a large number of positions/orders/transactions, the initial sync may take a while to complete. `last_successful_sync``string (format: date-time) or null` The last time holdings were successfully synced by SnapTrade. `balance``object` Contains balance related information for the account. Show properties `total``object or null` Total market value of this account (includes cash, equity, fixed income, etc). This value is directly obtained from the brokerage and should reflect the most accurate value of the account. Show properties `amount``number` Total value denominated in the currency of the `currency` field. `currency``string` The ISO-4217 currency code for the amount. `status``string or null` The current status of the account. Can be either "open", "closed", "archived" or null if the status is unknown or not provided by the brokerage. `raw_type``string or null` The account type as provided by the brokerage `meta``object` Deprecated Refrain from usage of this field Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version. `portfolio_group``string (format: uuid)` Deprecated Refrain from usage of this field Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it. `cash_restrictions``array of strings` Deprecated Refrain from usage of this field This field is deprecated. Show properties `string` 1 \[\ \ 2\ \ {\ \ 3\ \ "id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",\ \ 4\ \ "brokerage\_authorization": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 5\ \ "name": "Robinhood Individual",\ \ 6\ \ "number": "Q6542138443",\ \ 7\ \ "institution\_name": "Robinhood",\ \ 8\ \ "created\_date": "2024-07-23T22:50:22.761Z",\ \ 9\ \ "sync\_status": {\ \ 10\ \ "transactions": {\ \ 11\ \ "initial\_sync\_completed": true,\ \ 12\ \ "last\_successful\_sync": "2022-01-24",\ \ 13\ \ "first\_transaction\_date": "2022-01-24"\ \ 14\ \ },\ \ 15\ \ "holdings": {\ \ 16\ \ "initial\_sync\_completed": true,\ \ 17\ \ "last\_successful\_sync": "2024-06-28 18:42:46.561408+00:00"\ \ 18\ \ }\ \ 19\ \ },\ \ 20\ \ "balance": {\ \ 21\ \ "total": {\ \ 22\ \ "amount": 15363.23,\ \ 23\ \ "currency": "USD"\ \ 24\ \ }\ \ 25\ \ },\ \ 26\ \ "status": "open",\ \ 27\ \ "raw\_type": "Margin",\ \ 28\ \ "meta": {\ \ 29\ \ "type": "Margin",\ \ 30\ \ "status": "ACTIVE",\ \ 31\ \ "institution\_name": "Robinhood"\ \ 32\ \ },\ \ 33\ \ "portfolio\_group": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 34\ \ "cash\_restrictions": \[\]\ \ 35\ \ }\ \ 36\ \ \] [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Get account detail / SnapTrade Account Information Get account detail ------------------ get `https://api.snaptrade.com/api/v1/accounts/{accountId}` Returns account detail known to SnapTrade for the specified account. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `object` A single account at a brokerage. Expand all... `id``string (format: uuid)` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated. `brokerage_authorization``string (format: uuid)` Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade. `name``string or null` A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity. `number``string` The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons. `institution_name``string` The name of the brokerage that holds the account. `created_date``string (format: date-time)` Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the brokerage. `sync_status``object` Contains status update for the account sync process between SnapTrade and the brokerage. Show properties `transactions``object` Status of account transaction sync. SnapTrade syncs transactions from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all transactions from the brokerage account as far back as the brokerage allows. Check [our integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=6fab8012ade6441fa0c6d9af9c55ce3a) for details on how far back we sync for each brokerage. 2. Daily sync - Once a day SnapTrade syncs new transactions from the brokerage. 3. Manual sync - You can retrigger an incremental sync of transactions with the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. Show properties `initial_sync_completed``boolean` Indicates if the initial sync of transactions has been completed. For accounts with a large number of transactions, the initial sync may take a while to complete. `last_successful_sync``string (format: date) or null` All transactions up to this date have been successfully synced. Please note that this is not the date of the last transaction, nor the last time SnapTrade attempted to sync transactions. `first_transaction_date``string (format: date) or null` The date of the first transaction in the account known to SnapTrade. It's possible that the account has transactions before this date, but they are not known to SnapTrade. `holdings``object` Status of account holdings sync. SnapTrade syncs holdings from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all holdings (positions, balances, recent orders, and transactions) immediately after the connection is established. 2. Daily sync - Once a day SnapTrade refreshes all holdings from the brokerage. 3. Manual sync - You can trigger a refresh of holdings with the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. Show properties `initial_sync_completed``boolean` Indicates if the initial sync of holdings has been completed. For accounts with a large number of positions/orders/transactions, the initial sync may take a while to complete. `last_successful_sync``string (format: date-time) or null` The last time holdings were successfully synced by SnapTrade. `balance``object` Contains balance related information for the account. Show properties `total``object or null` Total market value of this account (includes cash, equity, fixed income, etc). This value is directly obtained from the brokerage and should reflect the most accurate value of the account. Show properties `amount``number` Total value denominated in the currency of the `currency` field. `currency``string` The ISO-4217 currency code for the amount. `status``string or null` The current status of the account. Can be either "open", "closed", "archived" or null if the status is unknown or not provided by the brokerage. `raw_type``string or null` The account type as provided by the brokerage `meta``object` Deprecated Refrain from usage of this field Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version. `portfolio_group``string (format: uuid)` Deprecated Refrain from usage of this field Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it. `cash_restrictions``array of strings` Deprecated Refrain from usage of this field This field is deprecated. Show properties `string` 1 { 2 "id": "917c8734-8470-4a3e-a18f-57c3f2ee6631", 3 "brokerage\_authorization": "87b24961-b51e-4db8-9226-f198f6518a89", 4 "name": "Robinhood Individual", 5 "number": "Q6542138443", 6 "institution\_name": "Robinhood", 7 "created\_date": "2024-07-23T22:50:22.761Z", 8 "sync\_status": { 9 "transactions": { 10 "initial\_sync\_completed": true, 11 "last\_successful\_sync": "2022-01-24", 12 "first\_transaction\_date": "2022-01-24" 13 }, 14 "holdings": { 15 "initial\_sync\_completed": true, 16 "last\_successful\_sync": "2024-06-28 18:42:46.561408+00:00" 17 } 18 }, 19 "balance": { 20 "total": { 21 "amount": 15363.23, 22 "currency": "USD" 23 } 24 }, 25 "status": "open", 26 "raw\_type": "Margin", 27 "meta": { 28 "type": "Margin", 29 "status": "ACTIVE", 30 "institution\_name": "Robinhood" 31 }, 32 "portfolio\_group": "2bcd7cc3-e922-4976-bce1-9858296801c3", 33 "cash\_restrictions": \[\] 34 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # List account balances / SnapTrade Account Information List account balances --------------------- get `https://api.snaptrade.com/api/v1/accounts/{accountId}/balances` Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances) . The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `array of objects` Expand all... `object` Holds balance information for a single currency in an account. Show properties `currency``object` The currency of the balance. This applies to both `cash` and `buying_power`. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `cash``number or null` The amount of available cash in the account denominated in the currency of the `currency` field. `buying_power``number or null` Buying power only applies to margin accounts. For non-margin accounts, buying power should be the same as cash. Please note that this field is not always available for all brokerages. 1 \[\ \ 2\ \ {\ \ 3\ \ "currency": {\ \ 4\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 5\ \ "code": "USD",\ \ 6\ \ "name": "US Dollar"\ \ 7\ \ },\ \ 8\ \ "cash": 300.71,\ \ 9\ \ "buying\_power": 410.71\ \ 10\ \ }\ \ 11\ \ \] [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Get equity symbol quotes / SnapTrade Trading Get equity symbol quotes ------------------------ get `https://api.snaptrade.com/api/v1/accounts/{accountId}/quotes` Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . `symbols``string``required` List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator `use_ticker``boolean` Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided. Unset False True Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200500 `array of objects` List of symbols with the latest quotes from the brokerage. Expand all... `object` Show properties `symbol``object` Uniquely describes a single security + exchange combination across all brokerages. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `last_trade_price``number` The most recent trade price from the brokerage. `bid_price``number` The most recent bid price from the brokerage. `ask_price``number` The most recent price from the brokerage. `bid_size``number` The most recent bid size from the brokerage. `ask_size``number` The most recent ask size from the brokerage. 1 \[\ \ 2\ \ {\ \ 3\ \ "symbol": {\ \ 4\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 5\ \ "symbol": "VAB.TO",\ \ 6\ \ "raw\_symbol": "VAB",\ \ 7\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 8\ \ "currency": {\ \ 9\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 10\ \ "code": "USD",\ \ 11\ \ "name": "US Dollar"\ \ 12\ \ },\ \ 13\ \ "exchange": {\ \ 14\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 15\ \ "code": "TSX",\ \ 16\ \ "mic\_code": "XTSE",\ \ 17\ \ "name": "Toronto Stock Exchange",\ \ 18\ \ "timezone": "America/New\_York",\ \ 19\ \ "start\_time": "09:30:00",\ \ 20\ \ "close\_time": "16:00:00",\ \ 21\ \ "suffix": ".TO"\ \ 22\ \ },\ \ 23\ \ "type": {\ \ 24\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 25\ \ "code": "cs",\ \ 26\ \ "description": "Common Stock",\ \ 27\ \ "is\_supported": true\ \ 28\ \ },\ \ 29\ \ "figi\_code": "BBG000B9XRY4",\ \ 30\ \ "figi\_instrument": {\ \ 31\ \ "figi\_code": "BBG000B9Y5X2",\ \ 32\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 33\ \ },\ \ 34\ \ "currencies": \[\ \ 35\ \ {\ \ 36\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 37\ \ "code": "USD",\ \ 38\ \ "name": "US Dollar"\ \ 39\ \ }\ \ 40\ \ \]\ \ 41\ \ },\ \ 42\ \ "last\_trade\_price": 8.74,\ \ 43\ \ "bid\_price": 8.43,\ \ 44\ \ "ask\_price": 8.43,\ \ 45\ \ "bid\_size": 260,\ \ 46\ \ "ask\_size": 344\ \ 47\ \ }\ \ 48\ \ \] [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # List account positions / SnapTrade Account Information List account positions ---------------------- get `https://api.snaptrade.com/api/v1/accounts/{accountId}/positions` Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](https://docs.snaptrade.com/reference/Options/Options_listOptionHoldings) . The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `array of objects` Expand all... `object` Describes a single stock/ETF/crypto/mutual fund position in an account. Show properties `symbol``object` Uniquely describes a security for the position within an account. The distinction between this and the `symbol` child property is that this object is specific to a position within an account, while the `symbol` child property is universal across all brokerage accounts. The caller should rely on the `symbol` child property for most use cases. Show properties `symbol``object` Uniquely describes a single security + exchange combination across all brokerages. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `id``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `description``string` Deprecated Refrain from usage of this field This field is deprecated and the caller should use the `symbol` child property's `description` instead. `local_id``string or null` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `is_quotable``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `is_tradable``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `units``number or null` The number of shares of the position. This can be fractional or integer units. `price``number or null` Last known market price for the symbol. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices. `open_pnl``number or null` The profit or loss on the position since it was opened. This is calculated as the difference between the current market value of the position and the total cost of the position. It is recommended to calculate this value using the average purchase price and the current market price yourself, instead of relying on this field. `average_purchase_price``number or null` Cost basis _per share_ of this position. `fractional_units``number or null` Deprecated Refrain from usage of this field Deprecated, use the `units` field for both fractional and integer units going forward `currency``object` The 'position currency' (`price` and `average_purchase_price`). This currency can potentially be different from the 'listing currency' of the security. The 'listing currency' is what's quoted on the listing exchange, while the 'position currency' is what the brokerage uses to hold and value your position. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `cash_equivalent``boolean or null` If the position is a cash equivalent (usually a money market fund) that is also counted in account cash balance and buying power 1 \[\ \ 2\ \ {\ \ 3\ \ "symbol": {\ \ 4\ \ "symbol": {\ \ 5\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 6\ \ "symbol": "VAB.TO",\ \ 7\ \ "raw\_symbol": "VAB",\ \ 8\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 9\ \ "currency": {\ \ 10\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 11\ \ "code": "USD",\ \ 12\ \ "name": "US Dollar"\ \ 13\ \ },\ \ 14\ \ "exchange": {\ \ 15\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 16\ \ "code": "TSX",\ \ 17\ \ "mic\_code": "XTSE",\ \ 18\ \ "name": "Toronto Stock Exchange",\ \ 19\ \ "timezone": "America/New\_York",\ \ 20\ \ "start\_time": "09:30:00",\ \ 21\ \ "close\_time": "16:00:00",\ \ 22\ \ "suffix": ".TO"\ \ 23\ \ },\ \ 24\ \ "type": {\ \ 25\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 26\ \ "code": "cs",\ \ 27\ \ "description": "Common Stock",\ \ 28\ \ "is\_supported": true\ \ 29\ \ },\ \ 30\ \ "figi\_code": "BBG000B9XRY4",\ \ 31\ \ "figi\_instrument": {\ \ 32\ \ "figi\_code": "BBG000B9Y5X2",\ \ 33\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 34\ \ },\ \ 35\ \ "currencies": \[\ \ 36\ \ {\ \ 37\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 38\ \ "code": "USD",\ \ 39\ \ "name": "US Dollar"\ \ 40\ \ }\ \ 41\ \ \]\ \ 42\ \ },\ \ 43\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 44\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 45\ \ "local\_id": "3291231",\ \ 46\ \ "is\_quotable": true,\ \ 47\ \ "is\_tradable": true\ \ 48\ \ },\ \ 49\ \ "units": 40,\ \ 50\ \ "price": 113.15,\ \ 51\ \ "open\_pnl": 0.44,\ \ 52\ \ "average\_purchase\_price": 108.3353,\ \ 53\ \ "fractional\_units": 1.44,\ \ 54\ \ "currency": {\ \ 55\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 56\ \ "code": "USD",\ \ 57\ \ "name": "US Dollar"\ \ 58\ \ },\ \ 59\ \ "cash\_equivalent": false\ \ 60\ \ }\ \ 61\ \ \] [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Get crypto pairs / SnapTrade Trading Get crypto pairs ---------------- BETA get `https://api.snaptrade.com/api/v1/accounts/{accountId}/trading/instruments/cryptocurrencyPairs` Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . `base``string` The base currency of a pair (e.g., "BTC" in BTC/USD). Either fiat or cryptocurrency symbol, for fiat use ISO-4217 codes. `quote``string` The quote currency of a pair (e.g., "USD" in BTC/USD). Either fiat or cryptocurrency symbol, for fiat use ISO-4217 codes. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400500 `object` The instruments Expand all... `items``array of objects` Show properties `symbol``string` Cryptocurrency pair instrument symbol `base``string` The base currency of a pair (e.g., "BTC" in BTC/USD). Either fiat or cryptocurrency symbol, for fiat use ISO-4217 codes. `quote``string` The quote currency of a pair (e.g., "USD" in BTC/USD). Either fiat or cryptocurrency symbol, for fiat use ISO-4217 codes. 1 { 2 "items": \[\ \ 3\ \ {\ \ 4\ \ "symbol": "BTC-USD",\ \ 5\ \ "base": "BTC",\ \ 6\ \ "quote": "USD"\ \ 7\ \ }\ \ 8\ \ \] 9 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # List account option positions / SnapTrade Options List account option positions ----------------------------- get `https://api.snaptrade.com/api/v1/accounts/{accountId}/options` Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](https://docs.snaptrade.com/reference/Account%20Information/AccountInformation_getUserAccountPositions) . The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200500 `array of objects` Expand all... `object` Describes a single option position in an account. Show properties `symbol``object` Uniquely describes a security for the option position within an account. The distinction between this and the `option_symbol` child property is that this object is specific to a position within an account, while the `option_symbol` child property is universal across all brokerage accounts. The caller should rely on the `option_symbol` child property for most use cases. Show properties `option_symbol``object` Uniquely describes an option security + exchange combination across all brokerages. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `id``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `description``string` Deprecated Refrain from usage of this field This field is deprecated and the caller should use the `option_symbol` child property's `description` instead. `price``number or null` Last known market price _per share_ of the option contract. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices. `units``number` The number of contracts for this option position. A positive number indicates a long position, while a negative number indicates a short position. `average_purchase_price``number or null` Cost basis _per contract_ of this option position. To get the cost basis _per share_, divide this value by the number of shares per contract (usually 100). `currency``object or null` The currency of the price. This field is deprecated and will be removed in a future version. The currency of the price is determined by the currency of the underlying security. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. 1 \[\ \ 2\ \ {\ \ 3\ \ "symbol": {\ \ 4\ \ "option\_symbol": {\ \ 5\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 6\ \ "ticker": "AAPL 261218C00240000",\ \ 7\ \ "option\_type": "CALL",\ \ 8\ \ "strike\_price": 240,\ \ 9\ \ "expiration\_date": "2026-12-18",\ \ 10\ \ "is\_mini\_option": false,\ \ 11\ \ "underlying\_symbol": {\ \ 12\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 13\ \ "symbol": "SPY",\ \ 14\ \ "raw\_symbol": "VAB",\ \ 15\ \ "description": "SPDR S&P 500 ETF Trust",\ \ 16\ \ "currency": {\ \ 17\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 18\ \ "code": "USD",\ \ 19\ \ "name": "US Dollar"\ \ 20\ \ },\ \ 21\ \ "exchange": {\ \ 22\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 23\ \ "code": "ARCX",\ \ 24\ \ "mic\_code": "ARCA",\ \ 25\ \ "name": "NYSE ARCA",\ \ 26\ \ "timezone": "America/New\_York",\ \ 27\ \ "start\_time": "09:30:00",\ \ 28\ \ "close\_time": "16:00:00",\ \ 29\ \ "suffix": "None",\ \ 30\ \ "allows\_cryptocurrency\_symbols": false\ \ 31\ \ },\ \ 32\ \ "type": {\ \ 33\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 34\ \ "code": "cs",\ \ 35\ \ "description": "Common Stock",\ \ 36\ \ "is\_supported": true\ \ 37\ \ },\ \ 38\ \ "figi\_code": "BBG000B9XRY4",\ \ 39\ \ "figi\_instrument": {\ \ 40\ \ "figi\_code": "BBG000B9Y5X2",\ \ 41\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 42\ \ },\ \ 43\ \ "currencies": \[\ \ 44\ \ {\ \ 45\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 46\ \ "code": "USD",\ \ 47\ \ "name": "US Dollar"\ \ 48\ \ }\ \ 49\ \ \]\ \ 50\ \ }\ \ 51\ \ },\ \ 52\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 53\ \ "description": "SPY CALL 7/17 200"\ \ 54\ \ },\ \ 55\ \ "price": 38.4,\ \ 56\ \ "units": \-50,\ \ 57\ \ "average\_purchase\_price": 4126,\ \ 58\ \ "currency": {\ \ 59\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 60\ \ "code": "USD",\ \ 61\ \ "name": "US Dollar"\ \ 62\ \ }\ \ 63\ \ }\ \ 64\ \ \] [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Get crypto pair quote / SnapTrade Trading Get crypto pair quote --------------------- BETA get `https://api.snaptrade.com/api/v1/accounts/{accountId}/trading/instruments/cryptocurrencyPairs/{instrumentSymbol}/quote` Gets a quote for the specified account. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. `instrumentSymbol``string``required` Cryptocurrency pair instrument symbol Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400500 `object` `bid``string (format: decimal)` The highest price a buyer is willing to pay. `ask``string (format: decimal)` The lowest price a seller is willing to accept. `mid``string (format: decimal)` The market mid price. `timestamp``string (format: date-time)` The timestamp of the quote. 1 { 2 "bid": "123.45", 3 "ask": "123.45", 4 "mid": "123.45", 5 "timestamp": "2024-01-24T15:00:00.000Z" 6 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Preview crypto order / SnapTrade Trading Preview crypto order -------------------- post `https://api.snaptrade.com/api/v1/accounts/{accountId}/trading/crypto/preview` Previews an order using the specified account. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Request Body `instrument``object``required` `symbol``string``required` The instrument's trading ticker symbol `type``string``required` The instrument's type `side``string``required` The action describes the intent or side of a trade. This is either `BUY` or `SELL`. `type``string``required` The type of order to place. `time_in_force``string``required` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. * `GTD` - Good Til Date. The order is valid until the specified date. `amount``string (format: decimal)``required` The amount of the base currency to buy or sell. `limit_price``string (format: decimal)` The limit price. Required if the order type is LIMIT, STOP\_LOSS\_LIMIT or TAKE\_PROFIT\_LIMIT. `stop_price``string (format: decimal)` The stop price. Required if the order type is STOP\_LOSS\_MARKET, STOP\_LOSS\_LIMIT, TAKE\_PROFIT\_MARKET or TAKE\_PROFIT\_LIMIT. `post_only``boolean` Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. Unset False True `expiration_date``string (format: date-time)` The expiration date of the order. Required if the time\_in\_force is GTD. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400500 `object` Preview of an order. Expand all... `estimated_fee``object` The estimated order fee. Show properties `currency``string` Symbol to identify a cryptocurrency or fiat currency on a crypto exchange. Fiat currencies symbols are ISO-4217 codes. `amount``string (format: decimal)` 1 { 2 "estimated\_fee": { 3 "currency": "BTC", 4 "amount": "123.45" 5 } 6 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Cancel order / SnapTrade Trading Cancel order ------------ post `https://api.snaptrade.com/api/v1/accounts/{accountId}/trading/cancel` Cancels an order in the specified account. Accepts order IDs for all asset types. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Request Body `brokerage_order_id``string``required` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400500 `object` `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `raw_response``object or null` The raw response from the brokerage. 1 { 2 "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e", 3 "raw\_response": { 4 "order\_id": "1234567890", 5 "status": "CANCELLED" 6 } 7 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Check equity order impact / SnapTrade Trading Check equity order impact ------------------------- post `https://api.snaptrade.com/api/v1/trade/impact` Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](https://docs.snaptrade.com/reference/Trading/Trading_placeOrder) . Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected. #### Execute an API Request Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Request Body `account_id``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. `action``string``required` The action describes the intent or side of a trade. This is either `BUY` or `SELL`. `universal_symbol_id``string (format: uuid)``required` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `order_type``string``required` The type of order to place. * For `Limit` and `StopLimit` orders, the `price` field is required. * For `Stop` and `StopLimit` orders, the `stop` field is required. `time_in_force``string``required` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. `price``number or null` The limit price for `Limit` and `StopLimit` orders. `stop``number or null` The price at which a stop order is triggered for `Stop` and `StopLimit` orders. `units``number or null` Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided. `notional_value` `or null` Total notional amount for the order. Must be `null` if `units` is provided. Can only work with `Market` for `order_type` and `Day` for `time_in_force`. This is only available for certain brokerages. Please check the [integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=e7bbcbf9f272441593f93decde660687) for more information. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400403500 `object` Expand all... `trade``object` Contains the details of a submitted order. Show properties `id``string (format: uuid)` Unique identifier for the submitted order through SnapTrade. `account``string (format: uuid)` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. `order_type``string` The type of order to place. * For `Limit` and `StopLimit` orders, the `price` field is required. * For `Stop` and `StopLimit` orders, the `stop` field is required. `time_in_force``string` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. `symbol``object` Information about the security for the order. Show properties `universal_symbol_id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `currency``object` Describes a currency object. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `local_id``string` Deprecated Refrain from usage of this field This field is deprecated and should not be used. `description``string or null` Deprecated Refrain from usage of this field This field is deprecated and should not be used. `symbol``string` Deprecated Refrain from usage of this field This field is deprecated and should not be used. `brokerage_symbol_id``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `action``string` The action describes the intent or side of a trade. This is either `BUY` or `SELL`. `units``number or null` Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided. `price``number or null` Trade Price if limit or stop limit order `trade_impacts``array of objects` List of impacts of the trade on the account. The list always contains one value at the moment. Show properties `account``string (format: uuid)` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. `currency``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `remaining_cash``number or null` Estimated amount of cash remaining in the account after the trade. `estimated_commission``number or null` Estimated commission for the trade. `forex_fees``number or null` Estimated foreign transaction fees for the trade. `combined_remaining_balance``object` Estimated remaining balance of the account after the trade is executed. Show properties `account``object` A single account at a brokerage. Show properties `id``string (format: uuid)` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. `name``string` A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity. `number``string` The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons. `sync_status``object` Contains status update for the account sync process between SnapTrade and the brokerage. Show properties `transactions``object` Status of account transaction sync. SnapTrade syncs transactions from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all transactions from the brokerage account as far back as the brokerage allows. Check [our integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=6fab8012ade6441fa0c6d9af9c55ce3a) for details on how far back we sync for each brokerage. 2. Daily sync - Once a day SnapTrade syncs new transactions from the brokerage. 3. Manual sync - You can retrigger an incremental sync of transactions with the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. Show properties `initial_sync_completed``boolean` Indicates if the initial sync of transactions has been completed. For accounts with a large number of transactions, the initial sync may take a while to complete. `last_successful_sync``string (format: date) or null` All transactions up to this date have been successfully synced. Please note that this is not the date of the last transaction, nor the last time SnapTrade attempted to sync transactions. `first_transaction_date``string (format: date) or null` The date of the first transaction in the account known to SnapTrade. It's possible that the account has transactions before this date, but they are not known to SnapTrade. `holdings``object` Status of account holdings sync. SnapTrade syncs holdings from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all holdings (positions, balances, recent orders, and transactions) immediately after the connection is established. 2. Daily sync - Once a day SnapTrade refreshes all holdings from the brokerage. 3. Manual sync - You can trigger a refresh of holdings with the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. Show properties `initial_sync_completed``boolean` Indicates if the initial sync of holdings has been completed. For accounts with a large number of positions/orders/transactions, the initial sync may take a while to complete. `last_successful_sync``string (format: date-time) or null` The last time holdings were successfully synced by SnapTrade. `currency``object` Describes a currency object. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `cash``number or null` Estimated amount of cash remaining in the account after the trade. At the moment this is the same as `remaining_cash` under `trade_impacts`. 1 { 2 "trade": { 3 "id": "139e307a-82f7-4402-b39e-4da7baa87758", 4 "account": "917c8734-8470-4a3e-a18f-57c3f2ee6631", 5 "order\_type": "Market", 6 "time\_in\_force": "Day", 7 "symbol": { 8 "universal\_symbol\_id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 9 "currency": { 10 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 11 "code": "USD", 12 "name": "US Dollar" 13 }, 14 "local\_id": "1048101", 15 "description": "Metaverse Global ETF", 16 "symbol": "MVGP.U.TO", 17 "brokerage\_symbol\_id": "2bcd7cc3-e922-4976-bce1-9858296801c3" 18 }, 19 "action": "BUY", 20 "units": 10.5, 21 "price": 31.33 22 }, 23 "trade\_impacts": \[\ \ 24\ \ {\ \ 25\ \ "account": "917c8734-8470-4a3e-a18f-57c3f2ee6631",\ \ 26\ \ "currency": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 27\ \ "remaining\_cash": 1.11,\ \ 28\ \ "estimated\_commission": 3.26,\ \ 29\ \ "forex\_fees": 5.26\ \ 30\ \ }\ \ 31\ \ \], 32 "combined\_remaining\_balance": { 33 "account": { 34 "id": "917c8734-8470-4a3e-a18f-57c3f2ee6631", 35 "name": "Robinhood Individual", 36 "number": "Q6542138443", 37 "sync\_status": { 38 "transactions": { 39 "initial\_sync\_completed": true, 40 "last\_successful\_sync": "2022-01-24", 41 "first\_transaction\_date": "2022-01-24" 42 }, 43 "holdings": { 44 "initial\_sync\_completed": true, 45 "last\_successful\_sync": "2024-06-28 18:42:46.561408+00:00" 46 } 47 } 48 }, 49 "currency": { 50 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 51 "code": "USD", 52 "name": "US Dollar" 53 }, 54 "cash": 1.11 55 } 56 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # List account holdings / SnapTrade Account Information List account holdings --------------------- get `https://api.snaptrade.com/api/v1/accounts/{accountId}/holdings` Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](https://docs.snaptrade.com/reference/Account%20Information/AccountInformation_getUserAccountBalance) , [positions](https://docs.snaptrade.com/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](https://docs.snaptrade.com/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. **The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.** The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400403425500 `object` A wrapper object containing holdings information for a single account. Expand all... `account``object` A single account at a brokerage. Show properties `id``string (format: uuid)` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated. `brokerage_authorization``string (format: uuid)` Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade. `name``string or null` A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity. `number``string` The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons. `institution_name``string` The name of the brokerage that holds the account. `created_date``string (format: date-time)` Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the brokerage. `sync_status``object` Contains status update for the account sync process between SnapTrade and the brokerage. Show properties `transactions``object` Status of account transaction sync. SnapTrade syncs transactions from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all transactions from the brokerage account as far back as the brokerage allows. Check [our integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=6fab8012ade6441fa0c6d9af9c55ce3a) for details on how far back we sync for each brokerage. 2. Daily sync - Once a day SnapTrade syncs new transactions from the brokerage. 3. Manual sync - You can retrigger an incremental sync of transactions with the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. Show properties `initial_sync_completed``boolean` Indicates if the initial sync of transactions has been completed. For accounts with a large number of transactions, the initial sync may take a while to complete. `last_successful_sync``string (format: date) or null` All transactions up to this date have been successfully synced. Please note that this is not the date of the last transaction, nor the last time SnapTrade attempted to sync transactions. `first_transaction_date``string (format: date) or null` The date of the first transaction in the account known to SnapTrade. It's possible that the account has transactions before this date, but they are not known to SnapTrade. `holdings``object` Status of account holdings sync. SnapTrade syncs holdings from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all holdings (positions, balances, recent orders, and transactions) immediately after the connection is established. 2. Daily sync - Once a day SnapTrade refreshes all holdings from the brokerage. 3. Manual sync - You can trigger a refresh of holdings with the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. Show properties `initial_sync_completed``boolean` Indicates if the initial sync of holdings has been completed. For accounts with a large number of positions/orders/transactions, the initial sync may take a while to complete. `last_successful_sync``string (format: date-time) or null` The last time holdings were successfully synced by SnapTrade. `balance``object` Contains balance related information for the account. Show properties `total``object or null` Total market value of this account (includes cash, equity, fixed income, etc). This value is directly obtained from the brokerage and should reflect the most accurate value of the account. Show properties `amount``number` Total value denominated in the currency of the `currency` field. `currency``string` The ISO-4217 currency code for the amount. `status``string or null` The current status of the account. Can be either "open", "closed", "archived" or null if the status is unknown or not provided by the brokerage. `raw_type``string or null` The account type as provided by the brokerage `meta``object` Deprecated Refrain from usage of this field Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version. `portfolio_group``string (format: uuid)` Deprecated Refrain from usage of this field Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it. `cash_restrictions``array of strings` Deprecated Refrain from usage of this field This field is deprecated. Show properties `string` `balances``array of objects or null` List of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances) . Show properties `currency``object` The currency of the balance. This applies to both `cash` and `buying_power`. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `cash``number or null` The amount of available cash in the account denominated in the currency of the `currency` field. `buying_power``number or null` Buying power only applies to margin accounts. For non-margin accounts, buying power should be the same as cash. Please note that this field is not always available for all brokerages. `positions``array of objects or null` List of stock/ETF/crypto/mutual fund positions in the account. Show properties `symbol``object` Uniquely describes a security for the position within an account. The distinction between this and the `symbol` child property is that this object is specific to a position within an account, while the `symbol` child property is universal across all brokerage accounts. The caller should rely on the `symbol` child property for most use cases. Show properties `symbol``object` Uniquely describes a single security + exchange combination across all brokerages. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `id``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `description``string` Deprecated Refrain from usage of this field This field is deprecated and the caller should use the `symbol` child property's `description` instead. `local_id``string or null` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `is_quotable``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `is_tradable``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `units``number or null` The number of shares of the position. This can be fractional or integer units. `price``number or null` Last known market price for the symbol. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices. `open_pnl``number or null` The profit or loss on the position since it was opened. This is calculated as the difference between the current market value of the position and the total cost of the position. It is recommended to calculate this value using the average purchase price and the current market price yourself, instead of relying on this field. `average_purchase_price``number or null` Cost basis _per share_ of this position. `fractional_units``number or null` Deprecated Refrain from usage of this field Deprecated, use the `units` field for both fractional and integer units going forward `currency``object` The 'position currency' (`price` and `average_purchase_price`). This currency can potentially be different from the 'listing currency' of the security. The 'listing currency' is what's quoted on the listing exchange, while the 'position currency' is what the brokerage uses to hold and value your position. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `cash_equivalent``boolean or null` If the position is a cash equivalent (usually a money market fund) that is also counted in account cash balance and buying power `option_positions``array of objects or null` List of option positions in the account. Show properties `symbol``object` Uniquely describes a security for the option position within an account. The distinction between this and the `option_symbol` child property is that this object is specific to a position within an account, while the `option_symbol` child property is universal across all brokerage accounts. The caller should rely on the `option_symbol` child property for most use cases. Show properties `option_symbol``object` Uniquely describes an option security + exchange combination across all brokerages. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `id``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `description``string` Deprecated Refrain from usage of this field This field is deprecated and the caller should use the `option_symbol` child property's `description` instead. `price``number or null` Last known market price _per share_ of the option contract. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices. `units``number` The number of contracts for this option position. A positive number indicates a long position, while a negative number indicates a short position. `average_purchase_price``number or null` Cost basis _per contract_ of this option position. To get the cost basis _per share_, divide this value by the number of shares per contract (usually 100). `currency``object or null` The currency of the price. This field is deprecated and will be removed in a future version. The currency of the price is determined by the currency of the underlying security. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `orders``array of objects or null` List of recent orders in the account, including both pending and executed orders. Note that option orders are included in this list. Option orders will have a null `universal_symbol` field and a non-null `option_symbol` field. Show properties `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `status``string` Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. `universal_symbol``object` Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `option_symbol``object` Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_universal_symbol``object` Quote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_currency``object` Quote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `action``string` The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. * BUY * SELL * BUY\_COVER * SELL\_SHORT * BUY\_OPEN * BUY\_CLOSE * SELL\_OPEN * SELL\_CLOSE `total_quantity``string or null` The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares. `open_quantity``string or null` The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares. `canceled_quantity``string or null` The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares. `filled_quantity``string or null` The number of shares or contracts that have been filled. Can be a decimal number for fractional shares. `execution_price``number or null` The price at which the order was executed. `limit_price``number or null` The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. `stop_price``number or null` The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. `order_type``string or null` The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value. `time_in_force``string` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value. * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. * `GTD` - Good Til Date. The order is valid until the specified date. * `MOO` - Market On Open. The order is to be executed at the day's opening price. * `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. `time_placed``string (format: date-time)` The time the order was placed. This is the time the order was submitted to the brokerage. `time_updated``string (format: date-time) or null` The time the order was last updated in the brokerage system. This value is not always available from the brokerage. `time_executed``string (format: date-time) or null` The time the order was executed in the brokerage system. This value is not always available from the brokerage. `expiry_date``string (format: date-time) or null` The time the order expires. This value is not always available from the brokerage. `symbol``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `child_brokerage_order_ids``object or null` Show properties `take_profit_order_id``string` The brokerage order ID for the take profit leg of the bracket order `stop_loss_order_id``string` The brokerage order ID for the stop loss leg of the bracket order `total_value``object` Deprecated Refrain from usage of this field This field is deprecated. To get the brokerage reported total market value of the account, please refer to `account.balance.total`. The total market value of the account. Note that this field is calculated based on the sum of the values of account positions and cash balances known to SnapTrade. It may not be accurate if the brokerage account has holdings that SnapTrade is not aware of. For example, if the brokerage account holds assets that SnapTrade does not support, the total value may be underreported. In certain cases, this value may also be double-counting cash-equivalent assets if those assets are represented as both cash and positions in the account. Show properties `value``number or null` Total value denominated in the currency of the `currency` field. `currency``string or null` The ISO-4217 currency code for the amount. 1 { 2 "account": { 3 "id": "917c8734-8470-4a3e-a18f-57c3f2ee6631", 4 "brokerage\_authorization": "87b24961-b51e-4db8-9226-f198f6518a89", 5 "name": "Robinhood Individual", 6 "number": "Q6542138443", 7 "institution\_name": "Robinhood", 8 "created\_date": "2024-07-23T22:50:22.761Z", 9 "sync\_status": { 10 "transactions": { 11 "initial\_sync\_completed": true, 12 "last\_successful\_sync": "2022-01-24", 13 "first\_transaction\_date": "2022-01-24" 14 }, 15 "holdings": { 16 "initial\_sync\_completed": true, 17 "last\_successful\_sync": "2024-06-28 18:42:46.561408+00:00" 18 } 19 }, 20 "balance": { 21 "total": { 22 "amount": 15363.23, 23 "currency": "USD" 24 } 25 }, 26 "status": "open", 27 "raw\_type": "Margin", 28 "meta": { 29 "type": "Margin", 30 "status": "ACTIVE", 31 "institution\_name": "Robinhood" 32 }, 33 "portfolio\_group": "2bcd7cc3-e922-4976-bce1-9858296801c3", 34 "cash\_restrictions": \[\] 35 }, 36 "balances": \[\ \ 37\ \ {\ \ 38\ \ "currency": {\ \ 39\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 40\ \ "code": "USD",\ \ 41\ \ "name": "US Dollar"\ \ 42\ \ },\ \ 43\ \ "cash": 300.71,\ \ 44\ \ "buying\_power": 410.71\ \ 45\ \ }\ \ 46\ \ \], 47 "positions": \[\ \ 48\ \ {\ \ 49\ \ "symbol": {\ \ 50\ \ "symbol": {\ \ 51\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 52\ \ "symbol": "VAB.TO",\ \ 53\ \ "raw\_symbol": "VAB",\ \ 54\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 55\ \ "currency": {\ \ 56\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 57\ \ "code": "USD",\ \ 58\ \ "name": "US Dollar"\ \ 59\ \ },\ \ 60\ \ "exchange": {\ \ 61\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 62\ \ "code": "TSX",\ \ 63\ \ "mic\_code": "XTSE",\ \ 64\ \ "name": "Toronto Stock Exchange",\ \ 65\ \ "timezone": "America/New\_York",\ \ 66\ \ "start\_time": "09:30:00",\ \ 67\ \ "close\_time": "16:00:00",\ \ 68\ \ "suffix": ".TO"\ \ 69\ \ },\ \ 70\ \ "type": {\ \ 71\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 72\ \ "code": "cs",\ \ 73\ \ "description": "Common Stock",\ \ 74\ \ "is\_supported": true\ \ 75\ \ },\ \ 76\ \ "figi\_code": "BBG000B9XRY4",\ \ 77\ \ "figi\_instrument": {\ \ 78\ \ "figi\_code": "BBG000B9Y5X2",\ \ 79\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 80\ \ },\ \ 81\ \ "currencies": \[\ \ 82\ \ {\ \ 83\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 84\ \ "code": "USD",\ \ 85\ \ "name": "US Dollar"\ \ 86\ \ }\ \ 87\ \ \]\ \ 88\ \ },\ \ 89\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 90\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 91\ \ "local\_id": "3291231",\ \ 92\ \ "is\_quotable": true,\ \ 93\ \ "is\_tradable": true\ \ 94\ \ },\ \ 95\ \ "units": 40,\ \ 96\ \ "price": 113.15,\ \ 97\ \ "open\_pnl": 0.44,\ \ 98\ \ "average\_purchase\_price": 108.3353,\ \ 99\ \ "fractional\_units": 1.44,\ \ 100\ \ "currency": {\ \ 101\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 102\ \ "code": "USD",\ \ 103\ \ "name": "US Dollar"\ \ 104\ \ },\ \ 105\ \ "cash\_equivalent": false\ \ 106\ \ }\ \ 107\ \ \], 108 "option\_positions": \[\ \ 109\ \ {\ \ 110\ \ "symbol": {\ \ 111\ \ "option\_symbol": {\ \ 112\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 113\ \ "ticker": "AAPL 261218C00240000",\ \ 114\ \ "option\_type": "CALL",\ \ 115\ \ "strike\_price": 240,\ \ 116\ \ "expiration\_date": "2026-12-18",\ \ 117\ \ "is\_mini\_option": false,\ \ 118\ \ "underlying\_symbol": {\ \ 119\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 120\ \ "symbol": "SPY",\ \ 121\ \ "raw\_symbol": "VAB",\ \ 122\ \ "description": "SPDR S&P 500 ETF Trust",\ \ 123\ \ "currency": {\ \ 124\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 125\ \ "code": "USD",\ \ 126\ \ "name": "US Dollar"\ \ 127\ \ },\ \ 128\ \ "exchange": {\ \ 129\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 130\ \ "code": "ARCX",\ \ 131\ \ "mic\_code": "ARCA",\ \ 132\ \ "name": "NYSE ARCA",\ \ 133\ \ "timezone": "America/New\_York",\ \ 134\ \ "start\_time": "09:30:00",\ \ 135\ \ "close\_time": "16:00:00",\ \ 136\ \ "suffix": "None",\ \ 137\ \ "allows\_cryptocurrency\_symbols": false\ \ 138\ \ },\ \ 139\ \ "type": {\ \ 140\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 141\ \ "code": "cs",\ \ 142\ \ "description": "Common Stock",\ \ 143\ \ "is\_supported": true\ \ 144\ \ },\ \ 145\ \ "figi\_code": "BBG000B9XRY4",\ \ 146\ \ "figi\_instrument": {\ \ 147\ \ "figi\_code": "BBG000B9Y5X2",\ \ 148\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 149\ \ },\ \ 150\ \ "currencies": \[\ \ 151\ \ {\ \ 152\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 153\ \ "code": "USD",\ \ 154\ \ "name": "US Dollar"\ \ 155\ \ }\ \ 156\ \ \]\ \ 157\ \ }\ \ 158\ \ },\ \ 159\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 160\ \ "description": "SPY CALL 7/17 200"\ \ 161\ \ },\ \ 162\ \ "price": 38.4,\ \ 163\ \ "units": \-50,\ \ 164\ \ "average\_purchase\_price": 4126,\ \ 165\ \ "currency": {\ \ 166\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 167\ \ "code": "USD",\ \ 168\ \ "name": "US Dollar"\ \ 169\ \ }\ \ 170\ \ }\ \ 171\ \ \], 172 "orders": \[\ \ 173\ \ {\ \ 174\ \ "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e",\ \ 175\ \ "status": "NONE",\ \ 176\ \ "universal\_symbol": {\ \ 177\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 178\ \ "symbol": "VAB.TO",\ \ 179\ \ "raw\_symbol": "VAB",\ \ 180\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 181\ \ "currency": {\ \ 182\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 183\ \ "code": "USD",\ \ 184\ \ "name": "US Dollar"\ \ 185\ \ },\ \ 186\ \ "exchange": {\ \ 187\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 188\ \ "code": "TSX",\ \ 189\ \ "mic\_code": "XTSE",\ \ 190\ \ "name": "Toronto Stock Exchange",\ \ 191\ \ "timezone": "America/New\_York",\ \ 192\ \ "start\_time": "09:30:00",\ \ 193\ \ "close\_time": "16:00:00",\ \ 194\ \ "suffix": ".TO"\ \ 195\ \ },\ \ 196\ \ "type": {\ \ 197\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 198\ \ "code": "cs",\ \ 199\ \ "description": "Common Stock",\ \ 200\ \ "is\_supported": true\ \ 201\ \ },\ \ 202\ \ "figi\_code": "BBG000B9XRY4",\ \ 203\ \ "figi\_instrument": {\ \ 204\ \ "figi\_code": "BBG000B9Y5X2",\ \ 205\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 206\ \ },\ \ 207\ \ "currencies": \[\ \ 208\ \ {\ \ 209\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 210\ \ "code": "USD",\ \ 211\ \ "name": "US Dollar"\ \ 212\ \ }\ \ 213\ \ \]\ \ 214\ \ },\ \ 215\ \ "option\_symbol": {\ \ 216\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 217\ \ "ticker": "AAPL 261218C00240000",\ \ 218\ \ "option\_type": "CALL",\ \ 219\ \ "strike\_price": 240,\ \ 220\ \ "expiration\_date": "2026-12-18",\ \ 221\ \ "is\_mini\_option": false,\ \ 222\ \ "underlying\_symbol": {\ \ 223\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 224\ \ "symbol": "SPY",\ \ 225\ \ "raw\_symbol": "VAB",\ \ 226\ \ "description": "SPDR S&P 500 ETF Trust",\ \ 227\ \ "currency": {\ \ 228\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 229\ \ "code": "USD",\ \ 230\ \ "name": "US Dollar"\ \ 231\ \ },\ \ 232\ \ "exchange": {\ \ 233\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 234\ \ "code": "ARCX",\ \ 235\ \ "mic\_code": "ARCA",\ \ 236\ \ "name": "NYSE ARCA",\ \ 237\ \ "timezone": "America/New\_York",\ \ 238\ \ "start\_time": "09:30:00",\ \ 239\ \ "close\_time": "16:00:00",\ \ 240\ \ "suffix": "None",\ \ 241\ \ "allows\_cryptocurrency\_symbols": false\ \ 242\ \ },\ \ 243\ \ "type": {\ \ 244\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 245\ \ "code": "cs",\ \ 246\ \ "description": "Common Stock",\ \ 247\ \ "is\_supported": true\ \ 248\ \ },\ \ 249\ \ "figi\_code": "BBG000B9XRY4",\ \ 250\ \ "figi\_instrument": {\ \ 251\ \ "figi\_code": "BBG000B9Y5X2",\ \ 252\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 253\ \ },\ \ 254\ \ "currencies": \[\ \ 255\ \ {\ \ 256\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 257\ \ "code": "USD",\ \ 258\ \ "name": "US Dollar"\ \ 259\ \ }\ \ 260\ \ \]\ \ 261\ \ }\ \ 262\ \ },\ \ 263\ \ "quote\_universal\_symbol": {\ \ 264\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 265\ \ "symbol": "VAB.TO",\ \ 266\ \ "raw\_symbol": "VAB",\ \ 267\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 268\ \ "currency": {\ \ 269\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 270\ \ "code": "USD",\ \ 271\ \ "name": "US Dollar"\ \ 272\ \ },\ \ 273\ \ "exchange": {\ \ 274\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 275\ \ "code": "TSX",\ \ 276\ \ "mic\_code": "XTSE",\ \ 277\ \ "name": "Toronto Stock Exchange",\ \ 278\ \ "timezone": "America/New\_York",\ \ 279\ \ "start\_time": "09:30:00",\ \ 280\ \ "close\_time": "16:00:00",\ \ 281\ \ "suffix": ".TO"\ \ 282\ \ },\ \ 283\ \ "type": {\ \ 284\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 285\ \ "code": "cs",\ \ 286\ \ "description": "Common Stock",\ \ 287\ \ "is\_supported": true\ \ 288\ \ },\ \ 289\ \ "figi\_code": "BBG000B9XRY4",\ \ 290\ \ "figi\_instrument": {\ \ 291\ \ "figi\_code": "BBG000B9Y5X2",\ \ 292\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 293\ \ },\ \ 294\ \ "currencies": \[\ \ 295\ \ {\ \ 296\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 297\ \ "code": "USD",\ \ 298\ \ "name": "US Dollar"\ \ 299\ \ }\ \ 300\ \ \]\ \ 301\ \ },\ \ 302\ \ "quote\_currency": {\ \ 303\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 304\ \ "code": "USD",\ \ 305\ \ "name": "US Dollar"\ \ 306\ \ },\ \ 307\ \ "action": "string",\ \ 308\ \ "total\_quantity": "100",\ \ 309\ \ "open\_quantity": "10",\ \ 310\ \ "canceled\_quantity": "10",\ \ 311\ \ "filled\_quantity": "80",\ \ 312\ \ "execution\_price": 12.34,\ \ 313\ \ "limit\_price": 12.34,\ \ 314\ \ "stop\_price": 12.5,\ \ 315\ \ "order\_type": "Market",\ \ 316\ \ "time\_in\_force": "string",\ \ 317\ \ "time\_placed": "2024-07-30T22:51:49.746Z",\ \ 318\ \ "time\_updated": "2024-08-05T00:05:57.409Z",\ \ 319\ \ "time\_executed": "2024-08-05T00:05:57.409Z",\ \ 320\ \ "expiry\_date": "2024-08-05T00:05:57.409Z",\ \ 321\ \ "symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 322\ \ "child\_brokerage\_order\_ids": {\ \ 323\ \ "take\_profit\_order\_id": "12345678",\ \ 324\ \ "stop\_loss\_order\_id": "12345678"\ \ 325\ \ }\ \ 326\ \ }\ \ 327\ \ \], 328 "total\_value": { 329 "value": 32600.71, 330 "currency": "USD" 331 } 332 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Get brokerage instruments / SnapTrade Reference Data Get brokerage instruments ------------------------- get `https://api.snaptrade.com/api/v1/brokerages/{slug}/instruments` Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list. #### Execute an API Request Path `slug``string``required` A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `object` Expand all... `instruments``array of objects` Show properties `symbol``string` The instrument's trading symbol / ticker. `exchange_mic``string or null` The MIC code of the exchange where the instrument is traded. `tradeable``boolean or null` Whether the instrument is tradeable through the brokerage. `null` if the tradeability is unknown. `fractionable``boolean or null` Whether the instrument allows fractional units. `null` if the fractionability is unknown. `universal_symbol_id``string (format: uuid) or null` The universal symbol ID of the instrument. This is the ID used to reference the instrument in SnapTrade API calls. 1 { 2 "instruments": \[\ \ 3\ \ {\ \ 4\ \ "symbol": "AAPL",\ \ 5\ \ "exchange\_mic": "XNAS",\ \ 6\ \ "tradeable": true,\ \ 7\ \ "fractionable": true,\ \ 8\ \ "universal\_symbol\_id": "2bcd7cc3-e922-4976-bce1-9858296801c3"\ \ 9\ \ }\ \ 10\ \ \] 11 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # List account activities / SnapTrade Account Information List account activities ----------------------- get `https://api.snaptrade.com/api/v1/accounts/{accountId}/activities` Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. The data returned here is always cached and refreshed once a day. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . `startDate``string (format: date)` The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`. `endDate``string (format: date)` The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`. `offset``integer (format: int32)` An integer that specifies the starting point of the paginated results. Default is 0. `limit``integer (format: int32)` An integer that specifies the maximum number of transactions to return. Default of 1000. `type``string` Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: * `BUY` - Asset bought. * `SELL` - Asset sold. * `DIVIDEND` - Dividend payout. * `CONTRIBUTION` - Cash contribution. * `WITHDRAWAL` - Cash withdrawal. * `REI` - Dividend reinvestment. * `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash * `INTEREST` - Interest deposited into the account. * `FEE` - Fee withdrawn from the account. * `OPTIONEXPIRATION` - Option expiration event. * `OPTIONASSIGNMENT` - Option assignment event. * `OPTIONEXERCISE` - Option exercise event. * `TRANSFER` - Transfer of assets from one account to another Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `object` A paginated list of UniversalActivity objects. Expand all... `data``array of objects` Show properties `id``string` Unique identifier for the transaction. This is the ID used to reference the transaction in SnapTrade. Please note that this ID _can_ change if the transaction is deleted and re-added. Under normal circumstances, SnapTrade does not delete transactions. The only time this would happen is if SnapTrade re-fetches and reprocesses the data from the brokerage, which is rare. If you require a stable ID, please let us know and we can work with you to provide one. `symbol``object or null` The security for the transaction. The field is `null` if the transaction is not related to a security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage's symbol. In cases where the brokerage symbol is not recognized, the field will be set to `null`. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `option_symbol``object or null` The option security for the transaction. The field is `null` if the transaction is not related to an option security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage's option symbol. In cases where the brokerage option symbol is not recognized, the field will be set to `null`. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `price``number` The price of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions. `units``number` The number of units of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions. `amount``number or null` The amount of the transaction denominated in `currency`. This can be positive or negative. In general, transactions that positively affect the account balance (like sell, deposits, dividends, etc) will have a positive amount, while transactions that negatively affect the account balance (like buy, withdrawals, fees, etc) will have a negative amount. `currency``object` The currency in which the transaction `price` and `amount` is denominated. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `type``string` A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values: * `BUY` - Asset bought. * `SELL` - Asset sold. * `DIVIDEND` - Dividend payout. * `CONTRIBUTION` - Cash contribution. * `WITHDRAWAL` - Cash withdrawal. * `REI` - Dividend reinvestment. * `INTEREST` - Interest deposited into the account. * `FEE` - Fee withdrawn from the account. * `OPTIONEXPIRATION` - Option expiration event. `option_symbol` contains the related option contract info. * `OPTIONASSIGNMENT` - Option assignment event. `option_symbol` contains the related option contract info. * `OPTIONEXERCISE` - Option exercise event. `option_symbol` contains the related option contract info. `option_type``string` If an option `BUY` or `SELL` transaction, this further specifies the type of action. The possible values are: * BUY\_TO\_OPEN * BUY\_TO\_CLOSE * SELL\_TO\_OPEN * SELL\_TO\_CLOSE `description``string` A human-readable description of the transaction. This is usually the brokerage's description of the transaction. `trade_date``string (format: date-time) or null` The recorded time for the transaction. The granularity of this timestamp depends on the brokerage. Some brokerages provide the exact time of the transaction, while others provide only the date. Please check the [integrations page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=6fab8012ade6441fa0c6d9af9c55ce3a) for the specific brokerage to see the granularity of the timestamps. Note that even though the field is named `trade_date`, it can represent any type of transaction, not just trades. `settlement_date``string (format: date-time)` The date on which the transaction is settled. `fee``number` Any fee associated with the transaction if provided by the brokerage. `fx_rate``number or null` The forex conversion rate involved in the transaction if provided by the brokerage. Used in cases where securities of one currency are purchased in a different currency, and the forex conversion is automatic. In those cases, price, amount and fee will be in the top level currency (activity -> currency) `institution``string` The institution that the transaction is associated with. This is usually the brokerage name. `external_reference_id``string or null` Reference ID from brokerage used to identify related transactions. For example if an order comprises of several transactions (buy, fee, fx), they can be grouped if they share the same `external_reference_id` `pagination``object` Details about the pagination of the results. Show properties `offset``integer` The starting point of the paginated results. `limit``integer` The maximum number of items to return in the response. `total``integer` The total number of items available to be returned over the API. 1 { 2 "data": \[\ \ 3\ \ {\ \ 4\ \ "id": "2f7dc9b3-5c33-4668-3440-2b31e056ebe6",\ \ 5\ \ "symbol": {\ \ 6\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 7\ \ "symbol": "VAB.TO",\ \ 8\ \ "raw\_symbol": "VAB",\ \ 9\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 10\ \ "currency": {\ \ 11\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 12\ \ "code": "USD",\ \ 13\ \ "name": "US Dollar"\ \ 14\ \ },\ \ 15\ \ "exchange": {\ \ 16\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 17\ \ "code": "TSX",\ \ 18\ \ "mic\_code": "XTSE",\ \ 19\ \ "name": "Toronto Stock Exchange",\ \ 20\ \ "timezone": "America/New\_York",\ \ 21\ \ "start\_time": "09:30:00",\ \ 22\ \ "close\_time": "16:00:00",\ \ 23\ \ "suffix": ".TO"\ \ 24\ \ },\ \ 25\ \ "type": {\ \ 26\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 27\ \ "code": "cs",\ \ 28\ \ "description": "Common Stock",\ \ 29\ \ "is\_supported": true\ \ 30\ \ },\ \ 31\ \ "figi\_code": "BBG000B9XRY4",\ \ 32\ \ "figi\_instrument": {\ \ 33\ \ "figi\_code": "BBG000B9Y5X2",\ \ 34\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 35\ \ }\ \ 36\ \ },\ \ 37\ \ "option\_symbol": {\ \ 38\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 39\ \ "ticker": "AAPL 261218C00240000",\ \ 40\ \ "option\_type": "CALL",\ \ 41\ \ "strike\_price": 240,\ \ 42\ \ "expiration\_date": "2026-12-18",\ \ 43\ \ "is\_mini\_option": false,\ \ 44\ \ "underlying\_symbol": {\ \ 45\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 46\ \ "symbol": "SPY",\ \ 47\ \ "raw\_symbol": "VAB",\ \ 48\ \ "description": "SPDR S&P 500 ETF Trust",\ \ 49\ \ "currency": {\ \ 50\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 51\ \ "code": "USD",\ \ 52\ \ "name": "US Dollar"\ \ 53\ \ },\ \ 54\ \ "exchange": {\ \ 55\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 56\ \ "code": "ARCX",\ \ 57\ \ "mic\_code": "ARCA",\ \ 58\ \ "name": "NYSE ARCA",\ \ 59\ \ "timezone": "America/New\_York",\ \ 60\ \ "start\_time": "09:30:00",\ \ 61\ \ "close\_time": "16:00:00",\ \ 62\ \ "suffix": "None",\ \ 63\ \ "allows\_cryptocurrency\_symbols": false\ \ 64\ \ },\ \ 65\ \ "type": {\ \ 66\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 67\ \ "code": "cs",\ \ 68\ \ "description": "Common Stock",\ \ 69\ \ "is\_supported": true\ \ 70\ \ },\ \ 71\ \ "figi\_code": "BBG000B9XRY4",\ \ 72\ \ "figi\_instrument": {\ \ 73\ \ "figi\_code": "BBG000B9Y5X2",\ \ 74\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 75\ \ },\ \ 76\ \ "currencies": \[\ \ 77\ \ {\ \ 78\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 79\ \ "code": "USD",\ \ 80\ \ "name": "US Dollar"\ \ 81\ \ }\ \ 82\ \ \]\ \ 83\ \ }\ \ 84\ \ },\ \ 85\ \ "price": 0.4,\ \ 86\ \ "units": 5.2,\ \ 87\ \ "amount": 263.82,\ \ 88\ \ "currency": {\ \ 89\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 90\ \ "code": "USD",\ \ 91\ \ "name": "US Dollar"\ \ 92\ \ },\ \ 93\ \ "type": "BUY",\ \ 94\ \ "option\_type": "BUY\_TO\_OPEN",\ \ 95\ \ "description": "WALT DISNEY UNIT DIST ON 21 SHS REC 12/31/21 PAY 01/06/22",\ \ 96\ \ "trade\_date": "2024-03-22T16:27:55.000Z",\ \ 97\ \ "settlement\_date": "2024-03-26T00:00:00.000Z",\ \ 98\ \ "fee": 0,\ \ 99\ \ "fx\_rate": 1.032,\ \ 100\ \ "institution": "Robinhood",\ \ 101\ \ "external\_reference\_id": "2f7dc9b3-5c33-4668-3440-2b31e056ebe6"\ \ 102\ \ }\ \ 103\ \ \], 104 "pagination": { 105 "offset": 0, 106 "limit": 100, 107 "total": 1000 108 } 109 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Get Client Info / SnapTrade Reference Data Get Client Info --------------- get `https://api.snaptrade.com/api/v1/snapTrade/partners` Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access. #### Execute an API Request No request parameters. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400401404500 `object` Configurations for your SnapTrade Client ID, including allowed brokerages and data access. Expand all... `slug``string` A short, unique identifier for your company or product. `name``string` Your company or product name. `logo_url``string` URL to your company or product logo. `allowed_brokerages``array of objects` Brokerages that can be accessed by your Client ID. Show properties `id``string (format: uuid)` Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade. `slug``string` A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change. `name``string` Full name of the brokerage. `display_name``string` A display-friendly name of the brokerage. `description``string` A brief description of the brokerage. `aws_s3_logo_url``string (format: url)` URL to the brokerage's logo. `aws_s3_square_logo_url``string (format: url) or null` URL to the brokerage's logo in square format. `url``string (format: url)` URL to the brokerage's website. `enabled``boolean` Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections. `maintenance_mode``boolean` Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections. `allows_trading``boolean or null` Whether the brokerage allows trading through SnapTrade. `allows_fractional_units``boolean or null` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `has_reporting``boolean or null` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `is_real_time_connection``boolean` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `brokerage_type``object` Type of brokerage. Currently supports traditional brokerages and crypto exchanges. Show properties `id``string (format: uuid)` `name``string` `exchanges``array of any` Deprecated Refrain from usage of this field This field is deprecated. Please contact us if you have a valid use case for it. `open_url``string (format: url) or null` Deprecated Refrain from usage of this field This field is deprecated. `can_access_trades``boolean` Whether trading is enabled for your SnapTrade Client ID. `can_access_holdings``boolean` Whether holdings data is enabled for your SnapTrade Client ID. `can_access_account_history``boolean` Whether account historical transactions is enabled for your SnapTrade Client ID. `can_access_reference_data``boolean` Whether reference data is enabled for your SnapTrade Client ID. `can_access_portfolio_management``boolean` Whether portfolio management is enabled for your SnapTrade Client ID. `can_access_orders``boolean` Whether recent order history is enabled for your SnapTrade Client ID. `redirect_uri``string` URI to redirect user back to after user is done adding brokerage connections. `pin_required``boolean` Deprecated Refrain from usage of this field Shows if pin is required by users to access connection page. This field has been deprecated. 1 { 2 "slug": "WEALTHLY", 3 "name": "Wealthly", 4 "logo\_url": "https://example.com/logo.png", 5 "allowed\_brokerages": \[\ \ 6\ \ {\ \ 7\ \ "id": "ebf91a5b-0920-4266-9e36-f6cfe8c40946",\ \ 8\ \ "slug": "ROBINHOOD",\ \ 9\ \ "name": "Robinhood",\ \ 10\ \ "display\_name": "Robinhood",\ \ 11\ \ "description": "Robinhood is an American multinational financial services corporation based in Menlo Park, California.",\ \ 12\ \ "aws\_s3\_logo\_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo.png",\ \ 13\ \ "aws\_s3\_square\_logo\_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo-square.png",\ \ 14\ \ "url": "https://robinhood.com",\ \ 15\ \ "enabled": true,\ \ 16\ \ "maintenance\_mode": true,\ \ 17\ \ "allows\_trading": true,\ \ 18\ \ "allows\_fractional\_units": true,\ \ 19\ \ "has\_reporting": true,\ \ 20\ \ "is\_real\_time\_connection": true,\ \ 21\ \ "brokerage\_type": {\ \ 22\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 23\ \ "name": "Traditional Brokerage"\ \ 24\ \ },\ \ 25\ \ "exchanges": \[\ \ 26\ \ "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 27\ \ "4bcd8cc3-c122-4974-dc21-1858296801f4"\ \ 28\ \ \],\ \ 29\ \ "open\_url": "string"\ \ 30\ \ }\ \ 31\ \ \], 32 "can\_access\_trades": true, 33 "can\_access\_holdings": true, 34 "can\_access\_account\_history": true, 35 "can\_access\_reference\_data": true, 36 "can\_access\_portfolio\_management": true, 37 "can\_access\_orders": true, 38 "redirect\_uri": "https://example.com/oauth/snaptrade", 39 "pin\_required": false 40 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Search account symbols / SnapTrade Reference Data Search account symbols ---------------------- post `https://api.snaptrade.com/api/v1/accounts/{accountId}/symbols` Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. The search results are further limited to the symbols supported by the brokerage for which the account is under. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Request Body `substring``string` The search query for symbols. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `array of objects` A list of Universal Symbol objects that match the given query. Expand all... `object` Uniquely describes a single security + exchange combination across all brokerages. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. 1 \[\ \ 2\ \ {\ \ 3\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 4\ \ "symbol": "VAB.TO",\ \ 5\ \ "raw\_symbol": "VAB",\ \ 6\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 7\ \ "currency": {\ \ 8\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 9\ \ "code": "USD",\ \ 10\ \ "name": "US Dollar"\ \ 11\ \ },\ \ 12\ \ "exchange": {\ \ 13\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 14\ \ "code": "TSX",\ \ 15\ \ "mic\_code": "XTSE",\ \ 16\ \ "name": "Toronto Stock Exchange",\ \ 17\ \ "timezone": "America/New\_York",\ \ 18\ \ "start\_time": "09:30:00",\ \ 19\ \ "close\_time": "16:00:00",\ \ 20\ \ "suffix": ".TO"\ \ 21\ \ },\ \ 22\ \ "type": {\ \ 23\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 24\ \ "code": "cs",\ \ 25\ \ "description": "Common Stock",\ \ 26\ \ "is\_supported": true\ \ 27\ \ },\ \ 28\ \ "figi\_code": "BBG000B9XRY4",\ \ 29\ \ "figi\_instrument": {\ \ 30\ \ "figi\_code": "BBG000B9Y5X2",\ \ 31\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 32\ \ },\ \ 33\ \ "currencies": \[\ \ 34\ \ {\ \ 35\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 36\ \ "code": "USD",\ \ 37\ \ "name": "US Dollar"\ \ 38\ \ }\ \ 39\ \ \]\ \ 40\ \ }\ \ 41\ \ \] [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # List security types / SnapTrade Reference Data List security types ------------------- get `https://api.snaptrade.com/api/v1/securityTypes` Return all available security types supported by SnapTrade. #### Execute an API Request No request parameters. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `array of objects` Expand all... `object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. 1 \[\ \ 2\ \ {\ \ 3\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 4\ \ "code": "cs",\ \ 5\ \ "description": "Common Stock",\ \ 6\ \ "is\_supported": true\ \ 7\ \ }\ \ 8\ \ \] [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Get symbol detail / SnapTrade Reference Data Get symbol detail ----------------- get `https://api.snaptrade.com/api/v1/symbols/{query}` Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results. #### Execute an API Request Path `query``string``required` The ticker or Universal Symbol ID to look up the symbol with. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200404default `object` Uniquely describes a single security + exchange combination across all brokerages. Expand all... `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. 1 { 2 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 3 "symbol": "VAB.TO", 4 "raw\_symbol": "VAB", 5 "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF", 6 "currency": { 7 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 8 "code": "USD", 9 "name": "US Dollar" 10 }, 11 "exchange": { 12 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 13 "code": "TSX", 14 "mic\_code": "XTSE", 15 "name": "Toronto Stock Exchange", 16 "timezone": "America/New\_York", 17 "start\_time": "09:30:00", 18 "close\_time": "16:00:00", 19 "suffix": ".TO" 20 }, 21 "type": { 22 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 23 "code": "cs", 24 "description": "Common Stock", 25 "is\_supported": true 26 }, 27 "figi\_code": "BBG000B9XRY4", 28 "figi\_instrument": { 29 "figi\_code": "BBG000B9Y5X2", 30 "figi\_share\_class": "BBG001S5N8V8" 31 }, 32 "currencies": \[\ \ 33\ \ {\ \ 34\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 35\ \ "code": "USD",\ \ 36\ \ "name": "US Dollar"\ \ 37\ \ }\ \ 38\ \ \] 39 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # List account recent orders (last 24 hours only) / SnapTrade Account Information List account recent orders (last 24 hours only) ----------------------------------------------- get `https://api.snaptrade.com/api/v1/accounts/{accountId}/recentOrders` A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days By default only returns executed orders, but that can be changed by setting _only\_executed_ to false **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) ** #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . `only_executed``boolean` Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well Unset False True Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200403500 `object` List of orders executed within the last 24 hours Expand all... `orders``array of objects` List of orders executed in the last 24 hours Show properties `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `status``string` Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. `universal_symbol``object` Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `option_symbol``object` Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_universal_symbol``object` Quote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_currency``object` Quote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `action``string` The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. * BUY * SELL * BUY\_COVER * SELL\_SHORT * BUY\_OPEN * BUY\_CLOSE * SELL\_OPEN * SELL\_CLOSE `total_quantity``string or null` The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares. `open_quantity``string or null` The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares. `canceled_quantity``string or null` The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares. `filled_quantity``string or null` The number of shares or contracts that have been filled. Can be a decimal number for fractional shares. `execution_price``number or null` The price at which the order was executed. `limit_price``number or null` The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. `stop_price``number or null` The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. `order_type``string or null` The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value. `time_in_force``string` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value. * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. * `GTD` - Good Til Date. The order is valid until the specified date. * `MOO` - Market On Open. The order is to be executed at the day's opening price. * `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. `time_placed``string (format: date-time)` The time the order was placed. This is the time the order was submitted to the brokerage. `time_updated``string (format: date-time) or null` The time the order was last updated in the brokerage system. This value is not always available from the brokerage. `time_executed``string (format: date-time) or null` The time the order was executed in the brokerage system. This value is not always available from the brokerage. `expiry_date``string (format: date-time) or null` The time the order expires. This value is not always available from the brokerage. `symbol``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `child_brokerage_order_ids``object or null` Show properties `take_profit_order_id``string` The brokerage order ID for the take profit leg of the bracket order `stop_loss_order_id``string` The brokerage order ID for the stop loss leg of the bracket order 1 { 2 "orders": \[\ \ 3\ \ {\ \ 4\ \ "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e",\ \ 5\ \ "status": "NONE",\ \ 6\ \ "universal\_symbol": {\ \ 7\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 8\ \ "symbol": "VAB.TO",\ \ 9\ \ "raw\_symbol": "VAB",\ \ 10\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 11\ \ "currency": {\ \ 12\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 13\ \ "code": "USD",\ \ 14\ \ "name": "US Dollar"\ \ 15\ \ },\ \ 16\ \ "exchange": {\ \ 17\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 18\ \ "code": "TSX",\ \ 19\ \ "mic\_code": "XTSE",\ \ 20\ \ "name": "Toronto Stock Exchange",\ \ 21\ \ "timezone": "America/New\_York",\ \ 22\ \ "start\_time": "09:30:00",\ \ 23\ \ "close\_time": "16:00:00",\ \ 24\ \ "suffix": ".TO"\ \ 25\ \ },\ \ 26\ \ "type": {\ \ 27\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 28\ \ "code": "cs",\ \ 29\ \ "description": "Common Stock",\ \ 30\ \ "is\_supported": true\ \ 31\ \ },\ \ 32\ \ "figi\_code": "BBG000B9XRY4",\ \ 33\ \ "figi\_instrument": {\ \ 34\ \ "figi\_code": "BBG000B9Y5X2",\ \ 35\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 36\ \ },\ \ 37\ \ "currencies": \[\ \ 38\ \ {\ \ 39\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 40\ \ "code": "USD",\ \ 41\ \ "name": "US Dollar"\ \ 42\ \ }\ \ 43\ \ \]\ \ 44\ \ },\ \ 45\ \ "option\_symbol": {\ \ 46\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 47\ \ "ticker": "AAPL 261218C00240000",\ \ 48\ \ "option\_type": "CALL",\ \ 49\ \ "strike\_price": 240,\ \ 50\ \ "expiration\_date": "2026-12-18",\ \ 51\ \ "is\_mini\_option": false,\ \ 52\ \ "underlying\_symbol": {\ \ 53\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 54\ \ "symbol": "SPY",\ \ 55\ \ "raw\_symbol": "VAB",\ \ 56\ \ "description": "SPDR S&P 500 ETF Trust",\ \ 57\ \ "currency": {\ \ 58\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 59\ \ "code": "USD",\ \ 60\ \ "name": "US Dollar"\ \ 61\ \ },\ \ 62\ \ "exchange": {\ \ 63\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 64\ \ "code": "ARCX",\ \ 65\ \ "mic\_code": "ARCA",\ \ 66\ \ "name": "NYSE ARCA",\ \ 67\ \ "timezone": "America/New\_York",\ \ 68\ \ "start\_time": "09:30:00",\ \ 69\ \ "close\_time": "16:00:00",\ \ 70\ \ "suffix": "None",\ \ 71\ \ "allows\_cryptocurrency\_symbols": false\ \ 72\ \ },\ \ 73\ \ "type": {\ \ 74\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 75\ \ "code": "cs",\ \ 76\ \ "description": "Common Stock",\ \ 77\ \ "is\_supported": true\ \ 78\ \ },\ \ 79\ \ "figi\_code": "BBG000B9XRY4",\ \ 80\ \ "figi\_instrument": {\ \ 81\ \ "figi\_code": "BBG000B9Y5X2",\ \ 82\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 83\ \ },\ \ 84\ \ "currencies": \[\ \ 85\ \ {\ \ 86\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 87\ \ "code": "USD",\ \ 88\ \ "name": "US Dollar"\ \ 89\ \ }\ \ 90\ \ \]\ \ 91\ \ }\ \ 92\ \ },\ \ 93\ \ "quote\_universal\_symbol": {\ \ 94\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 95\ \ "symbol": "VAB.TO",\ \ 96\ \ "raw\_symbol": "VAB",\ \ 97\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 98\ \ "currency": {\ \ 99\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 100\ \ "code": "USD",\ \ 101\ \ "name": "US Dollar"\ \ 102\ \ },\ \ 103\ \ "exchange": {\ \ 104\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 105\ \ "code": "TSX",\ \ 106\ \ "mic\_code": "XTSE",\ \ 107\ \ "name": "Toronto Stock Exchange",\ \ 108\ \ "timezone": "America/New\_York",\ \ 109\ \ "start\_time": "09:30:00",\ \ 110\ \ "close\_time": "16:00:00",\ \ 111\ \ "suffix": ".TO"\ \ 112\ \ },\ \ 113\ \ "type": {\ \ 114\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 115\ \ "code": "cs",\ \ 116\ \ "description": "Common Stock",\ \ 117\ \ "is\_supported": true\ \ 118\ \ },\ \ 119\ \ "figi\_code": "BBG000B9XRY4",\ \ 120\ \ "figi\_instrument": {\ \ 121\ \ "figi\_code": "BBG000B9Y5X2",\ \ 122\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 123\ \ },\ \ 124\ \ "currencies": \[\ \ 125\ \ {\ \ 126\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 127\ \ "code": "USD",\ \ 128\ \ "name": "US Dollar"\ \ 129\ \ }\ \ 130\ \ \]\ \ 131\ \ },\ \ 132\ \ "quote\_currency": {\ \ 133\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 134\ \ "code": "USD",\ \ 135\ \ "name": "US Dollar"\ \ 136\ \ },\ \ 137\ \ "action": "string",\ \ 138\ \ "total\_quantity": "100",\ \ 139\ \ "open\_quantity": "10",\ \ 140\ \ "canceled\_quantity": "10",\ \ 141\ \ "filled\_quantity": "80",\ \ 142\ \ "execution\_price": 12.34,\ \ 143\ \ "limit\_price": 12.34,\ \ 144\ \ "stop\_price": 12.5,\ \ 145\ \ "order\_type": "Market",\ \ 146\ \ "time\_in\_force": "string",\ \ 147\ \ "time\_placed": "2024-07-30T22:51:49.746Z",\ \ 148\ \ "time\_updated": "2024-08-05T00:05:57.409Z",\ \ 149\ \ "time\_executed": "2024-08-05T00:05:57.409Z",\ \ 150\ \ "expiry\_date": "2024-08-05T00:05:57.409Z",\ \ 151\ \ "symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 152\ \ "child\_brokerage\_order\_ids": {\ \ 153\ \ "take\_profit\_order\_id": "12345678",\ \ 154\ \ "stop\_loss\_order\_id": "12345678"\ \ 155\ \ }\ \ 156\ \ }\ \ 157\ \ \] 158 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # List account orders / SnapTrade Account Information List account orders ------------------- get `https://api.snaptrade.com/api/v1/accounts/{accountId}/orders` Returns a list of recent orders in the specified account. The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . `state``string` defaults value is set to "all" `days``integer (format: int32)` Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200500 `array of objects` Expand all... `object` Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records. Show properties `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `status``string` Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. `universal_symbol``object` Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `option_symbol``object` Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_universal_symbol``object` Quote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_currency``object` Quote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `action``string` The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. * BUY * SELL * BUY\_COVER * SELL\_SHORT * BUY\_OPEN * BUY\_CLOSE * SELL\_OPEN * SELL\_CLOSE `total_quantity``string or null` The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares. `open_quantity``string or null` The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares. `canceled_quantity``string or null` The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares. `filled_quantity``string or null` The number of shares or contracts that have been filled. Can be a decimal number for fractional shares. `execution_price``number or null` The price at which the order was executed. `limit_price``number or null` The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. `stop_price``number or null` The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. `order_type``string or null` The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value. `time_in_force``string` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value. * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. * `GTD` - Good Til Date. The order is valid until the specified date. * `MOO` - Market On Open. The order is to be executed at the day's opening price. * `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. `time_placed``string (format: date-time)` The time the order was placed. This is the time the order was submitted to the brokerage. `time_updated``string (format: date-time) or null` The time the order was last updated in the brokerage system. This value is not always available from the brokerage. `time_executed``string (format: date-time) or null` The time the order was executed in the brokerage system. This value is not always available from the brokerage. `expiry_date``string (format: date-time) or null` The time the order expires. This value is not always available from the brokerage. `symbol``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `child_brokerage_order_ids``object or null` Show properties `take_profit_order_id``string` The brokerage order ID for the take profit leg of the bracket order `stop_loss_order_id``string` The brokerage order ID for the stop loss leg of the bracket order 1 \[\ \ 2\ \ {\ \ 3\ \ "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e",\ \ 4\ \ "status": "NONE",\ \ 5\ \ "universal\_symbol": {\ \ 6\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 7\ \ "symbol": "VAB.TO",\ \ 8\ \ "raw\_symbol": "VAB",\ \ 9\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 10\ \ "currency": {\ \ 11\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 12\ \ "code": "USD",\ \ 13\ \ "name": "US Dollar"\ \ 14\ \ },\ \ 15\ \ "exchange": {\ \ 16\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 17\ \ "code": "TSX",\ \ 18\ \ "mic\_code": "XTSE",\ \ 19\ \ "name": "Toronto Stock Exchange",\ \ 20\ \ "timezone": "America/New\_York",\ \ 21\ \ "start\_time": "09:30:00",\ \ 22\ \ "close\_time": "16:00:00",\ \ 23\ \ "suffix": ".TO"\ \ 24\ \ },\ \ 25\ \ "type": {\ \ 26\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 27\ \ "code": "cs",\ \ 28\ \ "description": "Common Stock",\ \ 29\ \ "is\_supported": true\ \ 30\ \ },\ \ 31\ \ "figi\_code": "BBG000B9XRY4",\ \ 32\ \ "figi\_instrument": {\ \ 33\ \ "figi\_code": "BBG000B9Y5X2",\ \ 34\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 35\ \ },\ \ 36\ \ "currencies": \[\ \ 37\ \ {\ \ 38\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 39\ \ "code": "USD",\ \ 40\ \ "name": "US Dollar"\ \ 41\ \ }\ \ 42\ \ \]\ \ 43\ \ },\ \ 44\ \ "option\_symbol": {\ \ 45\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 46\ \ "ticker": "AAPL 261218C00240000",\ \ 47\ \ "option\_type": "CALL",\ \ 48\ \ "strike\_price": 240,\ \ 49\ \ "expiration\_date": "2026-12-18",\ \ 50\ \ "is\_mini\_option": false,\ \ 51\ \ "underlying\_symbol": {\ \ 52\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 53\ \ "symbol": "SPY",\ \ 54\ \ "raw\_symbol": "VAB",\ \ 55\ \ "description": "SPDR S&P 500 ETF Trust",\ \ 56\ \ "currency": {\ \ 57\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 58\ \ "code": "USD",\ \ 59\ \ "name": "US Dollar"\ \ 60\ \ },\ \ 61\ \ "exchange": {\ \ 62\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 63\ \ "code": "ARCX",\ \ 64\ \ "mic\_code": "ARCA",\ \ 65\ \ "name": "NYSE ARCA",\ \ 66\ \ "timezone": "America/New\_York",\ \ 67\ \ "start\_time": "09:30:00",\ \ 68\ \ "close\_time": "16:00:00",\ \ 69\ \ "suffix": "None",\ \ 70\ \ "allows\_cryptocurrency\_symbols": false\ \ 71\ \ },\ \ 72\ \ "type": {\ \ 73\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 74\ \ "code": "cs",\ \ 75\ \ "description": "Common Stock",\ \ 76\ \ "is\_supported": true\ \ 77\ \ },\ \ 78\ \ "figi\_code": "BBG000B9XRY4",\ \ 79\ \ "figi\_instrument": {\ \ 80\ \ "figi\_code": "BBG000B9Y5X2",\ \ 81\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 82\ \ },\ \ 83\ \ "currencies": \[\ \ 84\ \ {\ \ 85\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 86\ \ "code": "USD",\ \ 87\ \ "name": "US Dollar"\ \ 88\ \ }\ \ 89\ \ \]\ \ 90\ \ }\ \ 91\ \ },\ \ 92\ \ "quote\_universal\_symbol": {\ \ 93\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 94\ \ "symbol": "VAB.TO",\ \ 95\ \ "raw\_symbol": "VAB",\ \ 96\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 97\ \ "currency": {\ \ 98\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 99\ \ "code": "USD",\ \ 100\ \ "name": "US Dollar"\ \ 101\ \ },\ \ 102\ \ "exchange": {\ \ 103\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 104\ \ "code": "TSX",\ \ 105\ \ "mic\_code": "XTSE",\ \ 106\ \ "name": "Toronto Stock Exchange",\ \ 107\ \ "timezone": "America/New\_York",\ \ 108\ \ "start\_time": "09:30:00",\ \ 109\ \ "close\_time": "16:00:00",\ \ 110\ \ "suffix": ".TO"\ \ 111\ \ },\ \ 112\ \ "type": {\ \ 113\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 114\ \ "code": "cs",\ \ 115\ \ "description": "Common Stock",\ \ 116\ \ "is\_supported": true\ \ 117\ \ },\ \ 118\ \ "figi\_code": "BBG000B9XRY4",\ \ 119\ \ "figi\_instrument": {\ \ 120\ \ "figi\_code": "BBG000B9Y5X2",\ \ 121\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 122\ \ },\ \ 123\ \ "currencies": \[\ \ 124\ \ {\ \ 125\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 126\ \ "code": "USD",\ \ 127\ \ "name": "US Dollar"\ \ 128\ \ }\ \ 129\ \ \]\ \ 130\ \ },\ \ 131\ \ "quote\_currency": {\ \ 132\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 133\ \ "code": "USD",\ \ 134\ \ "name": "US Dollar"\ \ 135\ \ },\ \ 136\ \ "action": "string",\ \ 137\ \ "total\_quantity": "100",\ \ 138\ \ "open\_quantity": "10",\ \ 139\ \ "canceled\_quantity": "10",\ \ 140\ \ "filled\_quantity": "80",\ \ 141\ \ "execution\_price": 12.34,\ \ 142\ \ "limit\_price": 12.34,\ \ 143\ \ "stop\_price": 12.5,\ \ 144\ \ "order\_type": "Market",\ \ 145\ \ "time\_in\_force": "string",\ \ 146\ \ "time\_placed": "2024-07-30T22:51:49.746Z",\ \ 147\ \ "time\_updated": "2024-08-05T00:05:57.409Z",\ \ 148\ \ "time\_executed": "2024-08-05T00:05:57.409Z",\ \ 149\ \ "expiry\_date": "2024-08-05T00:05:57.409Z",\ \ 150\ \ "symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 151\ \ "child\_brokerage\_order\_ids": {\ \ 152\ \ "take\_profit\_order\_id": "12345678",\ \ 153\ \ "stop\_loss\_order\_id": "12345678"\ \ 154\ \ }\ \ 155\ \ }\ \ 156\ \ \] [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Search symbols / SnapTrade Reference Data Search symbols -------------- post `https://api.snaptrade.com/api/v1/symbols` Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. #### Execute an API Request Request Body `substring``string` The search query for symbols. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200default `array of objects` A list of Universal Symbol objects that match the given query. Expand all... `object` Uniquely describes a single security + exchange combination across all brokerages. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. 1 \[\ \ 2\ \ {\ \ 3\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 4\ \ "symbol": "VAB.TO",\ \ 5\ \ "raw\_symbol": "VAB",\ \ 6\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 7\ \ "currency": {\ \ 8\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 9\ \ "code": "USD",\ \ 10\ \ "name": "US Dollar"\ \ 11\ \ },\ \ 12\ \ "exchange": {\ \ 13\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 14\ \ "code": "TSX",\ \ 15\ \ "mic\_code": "XTSE",\ \ 16\ \ "name": "Toronto Stock Exchange",\ \ 17\ \ "timezone": "America/New\_York",\ \ 18\ \ "start\_time": "09:30:00",\ \ 19\ \ "close\_time": "16:00:00",\ \ 20\ \ "suffix": ".TO"\ \ 21\ \ },\ \ 22\ \ "type": {\ \ 23\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 24\ \ "code": "cs",\ \ 25\ \ "description": "Common Stock",\ \ 26\ \ "is\_supported": true\ \ 27\ \ },\ \ 28\ \ "figi\_code": "BBG000B9XRY4",\ \ 29\ \ "figi\_instrument": {\ \ 30\ \ "figi\_code": "BBG000B9Y5X2",\ \ 31\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 32\ \ },\ \ 33\ \ "currencies": \[\ \ 34\ \ {\ \ 35\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 36\ \ "code": "USD",\ \ 37\ \ "name": "US Dollar"\ \ 38\ \ }\ \ 39\ \ \]\ \ 40\ \ }\ \ 41\ \ \] [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Place checked equity order / SnapTrade Trading Place checked equity order -------------------------- post `https://api.snaptrade.com/api/v1/trade/{tradeId}` Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](https://docs.snaptrade.com/reference/Trading/Trading_getOrderImpact) . If you prefer to place the order without checking for impact first, you can use the [place order endpoint](https://docs.snaptrade.com/reference/Trading/Trading_placeForceOrder) . It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. #### Execute an API Request Path `tradeId``string (format: uuid)``required` Obtained from calling the [check order impact endpoint](https://docs.snaptrade.com/reference/Trading/Trading_getOrderImpact) Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Request Body `wait_to_confirm``boolean or null` Optional, defaults to true. Determines if a wait is performed to check on order status. If false, latency will be reduced but orders returned will be more likely to be of status `PENDING` as we will not wait to check on the status before responding to the request. Unset False True Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400500 `object` Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records. Expand all... `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `status``string` Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. `universal_symbol``object` Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `option_symbol``object` Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_universal_symbol``object` Quote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_currency``object` Quote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `action``string` The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. * BUY * SELL * BUY\_COVER * SELL\_SHORT * BUY\_OPEN * BUY\_CLOSE * SELL\_OPEN * SELL\_CLOSE `total_quantity``string or null` The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares. `open_quantity``string or null` The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares. `canceled_quantity``string or null` The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares. `filled_quantity``string or null` The number of shares or contracts that have been filled. Can be a decimal number for fractional shares. `execution_price``number or null` The price at which the order was executed. `limit_price``number or null` The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. `stop_price``number or null` The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. `order_type``string or null` The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value. `time_in_force``string` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value. * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. * `GTD` - Good Til Date. The order is valid until the specified date. * `MOO` - Market On Open. The order is to be executed at the day's opening price. * `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. `time_placed``string (format: date-time)` The time the order was placed. This is the time the order was submitted to the brokerage. `time_updated``string (format: date-time) or null` The time the order was last updated in the brokerage system. This value is not always available from the brokerage. `time_executed``string (format: date-time) or null` The time the order was executed in the brokerage system. This value is not always available from the brokerage. `expiry_date``string (format: date-time) or null` The time the order expires. This value is not always available from the brokerage. `symbol``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `child_brokerage_order_ids``object or null` Show properties `take_profit_order_id``string` The brokerage order ID for the take profit leg of the bracket order `stop_loss_order_id``string` The brokerage order ID for the stop loss leg of the bracket order 1 { 2 "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e", 3 "status": "NONE", 4 "universal\_symbol": { 5 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 6 "symbol": "VAB.TO", 7 "raw\_symbol": "VAB", 8 "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF", 9 "currency": { 10 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 11 "code": "USD", 12 "name": "US Dollar" 13 }, 14 "exchange": { 15 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 16 "code": "TSX", 17 "mic\_code": "XTSE", 18 "name": "Toronto Stock Exchange", 19 "timezone": "America/New\_York", 20 "start\_time": "09:30:00", 21 "close\_time": "16:00:00", 22 "suffix": ".TO" 23 }, 24 "type": { 25 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 26 "code": "cs", 27 "description": "Common Stock", 28 "is\_supported": true 29 }, 30 "figi\_code": "BBG000B9XRY4", 31 "figi\_instrument": { 32 "figi\_code": "BBG000B9Y5X2", 33 "figi\_share\_class": "BBG001S5N8V8" 34 }, 35 "currencies": \[\ \ 36\ \ {\ \ 37\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 38\ \ "code": "USD",\ \ 39\ \ "name": "US Dollar"\ \ 40\ \ }\ \ 41\ \ \] 42 }, 43 "option\_symbol": { 44 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 45 "ticker": "AAPL 261218C00240000", 46 "option\_type": "CALL", 47 "strike\_price": 240, 48 "expiration\_date": "2026-12-18", 49 "is\_mini\_option": false, 50 "underlying\_symbol": { 51 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 52 "symbol": "SPY", 53 "raw\_symbol": "VAB", 54 "description": "SPDR S&P 500 ETF Trust", 55 "currency": { 56 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 57 "code": "USD", 58 "name": "US Dollar" 59 }, 60 "exchange": { 61 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 62 "code": "ARCX", 63 "mic\_code": "ARCA", 64 "name": "NYSE ARCA", 65 "timezone": "America/New\_York", 66 "start\_time": "09:30:00", 67 "close\_time": "16:00:00", 68 "suffix": "None", 69 "allows\_cryptocurrency\_symbols": false 70 }, 71 "type": { 72 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 73 "code": "cs", 74 "description": "Common Stock", 75 "is\_supported": true 76 }, 77 "figi\_code": "BBG000B9XRY4", 78 "figi\_instrument": { 79 "figi\_code": "BBG000B9Y5X2", 80 "figi\_share\_class": "BBG001S5N8V8" 81 }, 82 "currencies": \[\ \ 83\ \ {\ \ 84\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 85\ \ "code": "USD",\ \ 86\ \ "name": "US Dollar"\ \ 87\ \ }\ \ 88\ \ \] 89 } 90 }, 91 "quote\_universal\_symbol": { 92 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 93 "symbol": "VAB.TO", 94 "raw\_symbol": "VAB", 95 "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF", 96 "currency": { 97 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 98 "code": "USD", 99 "name": "US Dollar" 100 }, 101 "exchange": { 102 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 103 "code": "TSX", 104 "mic\_code": "XTSE", 105 "name": "Toronto Stock Exchange", 106 "timezone": "America/New\_York", 107 "start\_time": "09:30:00", 108 "close\_time": "16:00:00", 109 "suffix": ".TO" 110 }, 111 "type": { 112 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 113 "code": "cs", 114 "description": "Common Stock", 115 "is\_supported": true 116 }, 117 "figi\_code": "BBG000B9XRY4", 118 "figi\_instrument": { 119 "figi\_code": "BBG000B9Y5X2", 120 "figi\_share\_class": "BBG001S5N8V8" 121 }, 122 "currencies": \[\ \ 123\ \ {\ \ 124\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 125\ \ "code": "USD",\ \ 126\ \ "name": "US Dollar"\ \ 127\ \ }\ \ 128\ \ \] 129 }, 130 "quote\_currency": { 131 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 132 "code": "USD", 133 "name": "US Dollar" 134 }, 135 "action": "string", 136 "total\_quantity": "100", 137 "open\_quantity": "10", 138 "canceled\_quantity": "10", 139 "filled\_quantity": "80", 140 "execution\_price": 12.34, 141 "limit\_price": 12.34, 142 "stop\_price": 12.5, 143 "order\_type": "Market", 144 "time\_in\_force": "string", 145 "time\_placed": "2024-07-30T22:51:49.746Z", 146 "time\_updated": "2024-08-05T00:05:57.409Z", 147 "time\_executed": "2024-08-05T00:05:57.409Z", 148 "expiry\_date": "2024-08-05T00:05:57.409Z", 149 "symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3", 150 "child\_brokerage\_order\_ids": { 151 "take\_profit\_order\_id": "12345678", 152 "stop\_loss\_order\_id": "12345678" 153 } 154 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Place option order / SnapTrade Trading Place option order ------------------ BETA post `https://api.snaptrade.com/api/v1/accounts/{accountId}/trading/options` Places a multi-leg option order. Only supported on certain option trading brokerages. https://snaptrade.notion.site/brokerages has information on brokerage trading support #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Request Body `order_type``string``required` The type of order to place. `time_in_force``string``required` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. `limit_price``string (format: decimal) or null` The limit price. Required if the order type is LIMIT, STOP\_LOSS\_LIMIT. `stop_price``string (format: decimal) or null` The stop price. Required if the order type is STOP\_LOSS\_MARKET, STOP\_LOSS\_LIMIT. `price_effect``string or null` The desired price\_effect for LIMIT and STOP\_LOSS\_LIMIT orders `legs``array of objects``required` Add Item Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400500 `object` Expand all... `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `orders``array of objects` Show properties `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `status``string` Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. `universal_symbol``object` Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `option_symbol``object` Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_universal_symbol``object` Quote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_currency``object` Quote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `action``string` The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. * BUY * SELL * BUY\_COVER * SELL\_SHORT * BUY\_OPEN * BUY\_CLOSE * SELL\_OPEN * SELL\_CLOSE `total_quantity``string or null` The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares. `open_quantity``string or null` The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares. `canceled_quantity``string or null` The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares. `filled_quantity``string or null` The number of shares or contracts that have been filled. Can be a decimal number for fractional shares. `execution_price``number or null` The price at which the order was executed. `limit_price``number or null` The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. `stop_price``number or null` The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. `order_type``string or null` The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value. `time_in_force``string` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value. * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. * `GTD` - Good Til Date. The order is valid until the specified date. * `MOO` - Market On Open. The order is to be executed at the day's opening price. * `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. `time_placed``string (format: date-time)` The time the order was placed. This is the time the order was submitted to the brokerage. `time_updated``string (format: date-time) or null` The time the order was last updated in the brokerage system. This value is not always available from the brokerage. `time_executed``string (format: date-time) or null` The time the order was executed in the brokerage system. This value is not always available from the brokerage. `expiry_date``string (format: date-time) or null` The time the order expires. This value is not always available from the brokerage. `symbol``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `child_brokerage_order_ids``object or null` Show properties `take_profit_order_id``string` The brokerage order ID for the take profit leg of the bracket order `stop_loss_order_id``string` The brokerage order ID for the stop loss leg of the bracket order 1 { 2 "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e", 3 "orders": \[\ \ 4\ \ {\ \ 5\ \ "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e",\ \ 6\ \ "status": "NONE",\ \ 7\ \ "universal\_symbol": {\ \ 8\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 9\ \ "symbol": "VAB.TO",\ \ 10\ \ "raw\_symbol": "VAB",\ \ 11\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 12\ \ "currency": {\ \ 13\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 14\ \ "code": "USD",\ \ 15\ \ "name": "US Dollar"\ \ 16\ \ },\ \ 17\ \ "exchange": {\ \ 18\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 19\ \ "code": "TSX",\ \ 20\ \ "mic\_code": "XTSE",\ \ 21\ \ "name": "Toronto Stock Exchange",\ \ 22\ \ "timezone": "America/New\_York",\ \ 23\ \ "start\_time": "09:30:00",\ \ 24\ \ "close\_time": "16:00:00",\ \ 25\ \ "suffix": ".TO"\ \ 26\ \ },\ \ 27\ \ "type": {\ \ 28\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 29\ \ "code": "cs",\ \ 30\ \ "description": "Common Stock",\ \ 31\ \ "is\_supported": true\ \ 32\ \ },\ \ 33\ \ "figi\_code": "BBG000B9XRY4",\ \ 34\ \ "figi\_instrument": {\ \ 35\ \ "figi\_code": "BBG000B9Y5X2",\ \ 36\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 37\ \ },\ \ 38\ \ "currencies": \[\ \ 39\ \ {\ \ 40\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 41\ \ "code": "USD",\ \ 42\ \ "name": "US Dollar"\ \ 43\ \ }\ \ 44\ \ \]\ \ 45\ \ },\ \ 46\ \ "option\_symbol": {\ \ 47\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 48\ \ "ticker": "AAPL 261218C00240000",\ \ 49\ \ "option\_type": "CALL",\ \ 50\ \ "strike\_price": 240,\ \ 51\ \ "expiration\_date": "2026-12-18",\ \ 52\ \ "is\_mini\_option": false,\ \ 53\ \ "underlying\_symbol": {\ \ 54\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 55\ \ "symbol": "SPY",\ \ 56\ \ "raw\_symbol": "VAB",\ \ 57\ \ "description": "SPDR S&P 500 ETF Trust",\ \ 58\ \ "currency": {\ \ 59\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 60\ \ "code": "USD",\ \ 61\ \ "name": "US Dollar"\ \ 62\ \ },\ \ 63\ \ "exchange": {\ \ 64\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 65\ \ "code": "ARCX",\ \ 66\ \ "mic\_code": "ARCA",\ \ 67\ \ "name": "NYSE ARCA",\ \ 68\ \ "timezone": "America/New\_York",\ \ 69\ \ "start\_time": "09:30:00",\ \ 70\ \ "close\_time": "16:00:00",\ \ 71\ \ "suffix": "None",\ \ 72\ \ "allows\_cryptocurrency\_symbols": false\ \ 73\ \ },\ \ 74\ \ "type": {\ \ 75\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 76\ \ "code": "cs",\ \ 77\ \ "description": "Common Stock",\ \ 78\ \ "is\_supported": true\ \ 79\ \ },\ \ 80\ \ "figi\_code": "BBG000B9XRY4",\ \ 81\ \ "figi\_instrument": {\ \ 82\ \ "figi\_code": "BBG000B9Y5X2",\ \ 83\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 84\ \ },\ \ 85\ \ "currencies": \[\ \ 86\ \ {\ \ 87\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 88\ \ "code": "USD",\ \ 89\ \ "name": "US Dollar"\ \ 90\ \ }\ \ 91\ \ \]\ \ 92\ \ }\ \ 93\ \ },\ \ 94\ \ "quote\_universal\_symbol": {\ \ 95\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 96\ \ "symbol": "VAB.TO",\ \ 97\ \ "raw\_symbol": "VAB",\ \ 98\ \ "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",\ \ 99\ \ "currency": {\ \ 100\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 101\ \ "code": "USD",\ \ 102\ \ "name": "US Dollar"\ \ 103\ \ },\ \ 104\ \ "exchange": {\ \ 105\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 106\ \ "code": "TSX",\ \ 107\ \ "mic\_code": "XTSE",\ \ 108\ \ "name": "Toronto Stock Exchange",\ \ 109\ \ "timezone": "America/New\_York",\ \ 110\ \ "start\_time": "09:30:00",\ \ 111\ \ "close\_time": "16:00:00",\ \ 112\ \ "suffix": ".TO"\ \ 113\ \ },\ \ 114\ \ "type": {\ \ 115\ \ "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 116\ \ "code": "cs",\ \ 117\ \ "description": "Common Stock",\ \ 118\ \ "is\_supported": true\ \ 119\ \ },\ \ 120\ \ "figi\_code": "BBG000B9XRY4",\ \ 121\ \ "figi\_instrument": {\ \ 122\ \ "figi\_code": "BBG000B9Y5X2",\ \ 123\ \ "figi\_share\_class": "BBG001S5N8V8"\ \ 124\ \ },\ \ 125\ \ "currencies": \[\ \ 126\ \ {\ \ 127\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 128\ \ "code": "USD",\ \ 129\ \ "name": "US Dollar"\ \ 130\ \ }\ \ 131\ \ \]\ \ 132\ \ },\ \ 133\ \ "quote\_currency": {\ \ 134\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 135\ \ "code": "USD",\ \ 136\ \ "name": "US Dollar"\ \ 137\ \ },\ \ 138\ \ "action": "string",\ \ 139\ \ "total\_quantity": "100",\ \ 140\ \ "open\_quantity": "10",\ \ 141\ \ "canceled\_quantity": "10",\ \ 142\ \ "filled\_quantity": "80",\ \ 143\ \ "execution\_price": 12.34,\ \ 144\ \ "limit\_price": 12.34,\ \ 145\ \ "stop\_price": 12.5,\ \ 146\ \ "order\_type": "Market",\ \ 147\ \ "time\_in\_force": "string",\ \ 148\ \ "time\_placed": "2024-07-30T22:51:49.746Z",\ \ 149\ \ "time\_updated": "2024-08-05T00:05:57.409Z",\ \ 150\ \ "time\_executed": "2024-08-05T00:05:57.409Z",\ \ 151\ \ "expiry\_date": "2024-08-05T00:05:57.409Z",\ \ 152\ \ "symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3",\ \ 153\ \ "child\_brokerage\_order\_ids": {\ \ 154\ \ "take\_profit\_order\_id": "12345678",\ \ 155\ \ "stop\_loss\_order\_id": "12345678"\ \ 156\ \ }\ \ 157\ \ }\ \ 158\ \ \] 159 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Place order / SnapTrade Trading Place order ----------- post `https://api.snaptrade.com/api/v1/trade/place` Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](https://docs.snaptrade.com/reference/Trading/Trading_getOrderImpact) . It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](https://docs.snaptrade.com/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. #### Execute an API Request Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Request Body `account_id``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. `action``string``required` The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options. `universal_symbol_id``string (format: uuid) or null` The universal symbol ID of the security to trade. Must be 'null' if `symbol` is provided, otherwise must be provided. `symbol``string or null` The security's trading ticker symbol. If 'symbol' is provided, then 'universal\_symbol\_id' must be 'null'. `order_type``string``required` The type of order to place. * For `Limit` and `StopLimit` orders, the `price` field is required. * For `Stop` and `StopLimit` orders, the `stop` field is required. `time_in_force``string``required` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. `price``number or null` The limit price for `Limit` and `StopLimit` orders. `stop``number or null` The price at which a stop order is triggered for `Stop` and `StopLimit` orders. `units``number or null` For Equity orders, this represents the number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided. If placing an Option order, this field represents the number of contracts to buy or sell. (e.g., 1 contract = 100 shares). `notional_value` `or null` Total notional amount for the order. Must be `null` if `units` is provided. Can only work with `Market` for `order_type` and `Day` for `time_in_force`. This is only available for certain brokerages. Please check the [integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=e7bbcbf9f272441593f93decde660687) for more information. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400403500 `object` Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records. Expand all... `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `status``string` Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. `universal_symbol``object` Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `option_symbol``object` Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_universal_symbol``object` Quote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_currency``object` Quote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `action``string` The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. * BUY * SELL * BUY\_COVER * SELL\_SHORT * BUY\_OPEN * BUY\_CLOSE * SELL\_OPEN * SELL\_CLOSE `total_quantity``string or null` The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares. `open_quantity``string or null` The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares. `canceled_quantity``string or null` The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares. `filled_quantity``string or null` The number of shares or contracts that have been filled. Can be a decimal number for fractional shares. `execution_price``number or null` The price at which the order was executed. `limit_price``number or null` The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. `stop_price``number or null` The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. `order_type``string or null` The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value. `time_in_force``string` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value. * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. * `GTD` - Good Til Date. The order is valid until the specified date. * `MOO` - Market On Open. The order is to be executed at the day's opening price. * `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. `time_placed``string (format: date-time)` The time the order was placed. This is the time the order was submitted to the brokerage. `time_updated``string (format: date-time) or null` The time the order was last updated in the brokerage system. This value is not always available from the brokerage. `time_executed``string (format: date-time) or null` The time the order was executed in the brokerage system. This value is not always available from the brokerage. `expiry_date``string (format: date-time) or null` The time the order expires. This value is not always available from the brokerage. `symbol``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `child_brokerage_order_ids``object or null` Show properties `take_profit_order_id``string` The brokerage order ID for the take profit leg of the bracket order `stop_loss_order_id``string` The brokerage order ID for the stop loss leg of the bracket order 1 { 2 "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e", 3 "status": "NONE", 4 "universal\_symbol": { 5 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 6 "symbol": "VAB.TO", 7 "raw\_symbol": "VAB", 8 "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF", 9 "currency": { 10 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 11 "code": "USD", 12 "name": "US Dollar" 13 }, 14 "exchange": { 15 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 16 "code": "TSX", 17 "mic\_code": "XTSE", 18 "name": "Toronto Stock Exchange", 19 "timezone": "America/New\_York", 20 "start\_time": "09:30:00", 21 "close\_time": "16:00:00", 22 "suffix": ".TO" 23 }, 24 "type": { 25 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 26 "code": "cs", 27 "description": "Common Stock", 28 "is\_supported": true 29 }, 30 "figi\_code": "BBG000B9XRY4", 31 "figi\_instrument": { 32 "figi\_code": "BBG000B9Y5X2", 33 "figi\_share\_class": "BBG001S5N8V8" 34 }, 35 "currencies": \[\ \ 36\ \ {\ \ 37\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 38\ \ "code": "USD",\ \ 39\ \ "name": "US Dollar"\ \ 40\ \ }\ \ 41\ \ \] 42 }, 43 "option\_symbol": { 44 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 45 "ticker": "AAPL 261218C00240000", 46 "option\_type": "CALL", 47 "strike\_price": 240, 48 "expiration\_date": "2026-12-18", 49 "is\_mini\_option": false, 50 "underlying\_symbol": { 51 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 52 "symbol": "SPY", 53 "raw\_symbol": "VAB", 54 "description": "SPDR S&P 500 ETF Trust", 55 "currency": { 56 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 57 "code": "USD", 58 "name": "US Dollar" 59 }, 60 "exchange": { 61 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 62 "code": "ARCX", 63 "mic\_code": "ARCA", 64 "name": "NYSE ARCA", 65 "timezone": "America/New\_York", 66 "start\_time": "09:30:00", 67 "close\_time": "16:00:00", 68 "suffix": "None", 69 "allows\_cryptocurrency\_symbols": false 70 }, 71 "type": { 72 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 73 "code": "cs", 74 "description": "Common Stock", 75 "is\_supported": true 76 }, 77 "figi\_code": "BBG000B9XRY4", 78 "figi\_instrument": { 79 "figi\_code": "BBG000B9Y5X2", 80 "figi\_share\_class": "BBG001S5N8V8" 81 }, 82 "currencies": \[\ \ 83\ \ {\ \ 84\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 85\ \ "code": "USD",\ \ 86\ \ "name": "US Dollar"\ \ 87\ \ }\ \ 88\ \ \] 89 } 90 }, 91 "quote\_universal\_symbol": { 92 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 93 "symbol": "VAB.TO", 94 "raw\_symbol": "VAB", 95 "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF", 96 "currency": { 97 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 98 "code": "USD", 99 "name": "US Dollar" 100 }, 101 "exchange": { 102 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 103 "code": "TSX", 104 "mic\_code": "XTSE", 105 "name": "Toronto Stock Exchange", 106 "timezone": "America/New\_York", 107 "start\_time": "09:30:00", 108 "close\_time": "16:00:00", 109 "suffix": ".TO" 110 }, 111 "type": { 112 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 113 "code": "cs", 114 "description": "Common Stock", 115 "is\_supported": true 116 }, 117 "figi\_code": "BBG000B9XRY4", 118 "figi\_instrument": { 119 "figi\_code": "BBG000B9Y5X2", 120 "figi\_share\_class": "BBG001S5N8V8" 121 }, 122 "currencies": \[\ \ 123\ \ {\ \ 124\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 125\ \ "code": "USD",\ \ 126\ \ "name": "US Dollar"\ \ 127\ \ }\ \ 128\ \ \] 129 }, 130 "quote\_currency": { 131 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 132 "code": "USD", 133 "name": "US Dollar" 134 }, 135 "action": "string", 136 "total\_quantity": "100", 137 "open\_quantity": "10", 138 "canceled\_quantity": "10", 139 "filled\_quantity": "80", 140 "execution\_price": 12.34, 141 "limit\_price": 12.34, 142 "stop\_price": 12.5, 143 "order\_type": "Market", 144 "time\_in\_force": "string", 145 "time\_placed": "2024-07-30T22:51:49.746Z", 146 "time\_updated": "2024-08-05T00:05:57.409Z", 147 "time\_executed": "2024-08-05T00:05:57.409Z", 148 "expiry\_date": "2024-08-05T00:05:57.409Z", 149 "symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3", 150 "child\_brokerage\_order\_ids": { 151 "take\_profit\_order\_id": "12345678", 152 "stop\_loss\_order\_id": "12345678" 153 } 154 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Place bracket order / SnapTrade Trading Place bracket order ------------------- BETA post `https://api.snaptrade.com/api/v1/accounts/{accountId}/trading/bracket` Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages #### Execute an API Request Path `accountId``string (format: uuid)``required` The ID of the account to execute the trade on. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Request Body `action``string``required` The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options. `instrument``object``required` `symbol``string``required` The instrument's trading ticker symbol. This currently supports stock symbols and Options symbols in the 21 character OCC format. For example `AAPL 131124C00240000` represents a call option on AAPL expiring on 2024-11-13 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) `type``string``required` The instrument's type `order_type``string``required` The type of order to place. * For `Limit` and `StopLimit` orders, the `price` field is required. * For `Stop` and `StopLimit` orders, the `stop` field is required. `time_in_force``string``required` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. `price``number or null` The limit price for `Limit` and `StopLimit` orders. `stop``number or null` The price at which a stop order is triggered for `Stop` and `StopLimit` orders. `units``number` Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided. `stop_loss``object``required` Takes in string value for stop\_price and limit\_price. stop\_price is required, limit\_price is optional `stop_price``string` `limit_price``string or null` `take_profit``object``required` Takes in a string value for limit\_price `limit_price``string` Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400403500 `object` Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records. Expand all... `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `status``string` Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. `universal_symbol``object` Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `option_symbol``object` Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_universal_symbol``object` Quote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_currency``object` Quote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `action``string` The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. * BUY * SELL * BUY\_COVER * SELL\_SHORT * BUY\_OPEN * BUY\_CLOSE * SELL\_OPEN * SELL\_CLOSE `total_quantity``string or null` The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares. `open_quantity``string or null` The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares. `canceled_quantity``string or null` The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares. `filled_quantity``string or null` The number of shares or contracts that have been filled. Can be a decimal number for fractional shares. `execution_price``number or null` The price at which the order was executed. `limit_price``number or null` The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. `stop_price``number or null` The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. `order_type``string or null` The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value. `time_in_force``string` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value. * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. * `GTD` - Good Til Date. The order is valid until the specified date. * `MOO` - Market On Open. The order is to be executed at the day's opening price. * `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. `time_placed``string (format: date-time)` The time the order was placed. This is the time the order was submitted to the brokerage. `time_updated``string (format: date-time) or null` The time the order was last updated in the brokerage system. This value is not always available from the brokerage. `time_executed``string (format: date-time) or null` The time the order was executed in the brokerage system. This value is not always available from the brokerage. `expiry_date``string (format: date-time) or null` The time the order expires. This value is not always available from the brokerage. `symbol``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `child_brokerage_order_ids``object or null` Show properties `take_profit_order_id``string` The brokerage order ID for the take profit leg of the bracket order `stop_loss_order_id``string` The brokerage order ID for the stop loss leg of the bracket order 1 { 2 "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e", 3 "status": "NONE", 4 "universal\_symbol": { 5 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 6 "symbol": "VAB.TO", 7 "raw\_symbol": "VAB", 8 "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF", 9 "currency": { 10 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 11 "code": "USD", 12 "name": "US Dollar" 13 }, 14 "exchange": { 15 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 16 "code": "TSX", 17 "mic\_code": "XTSE", 18 "name": "Toronto Stock Exchange", 19 "timezone": "America/New\_York", 20 "start\_time": "09:30:00", 21 "close\_time": "16:00:00", 22 "suffix": ".TO" 23 }, 24 "type": { 25 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 26 "code": "cs", 27 "description": "Common Stock", 28 "is\_supported": true 29 }, 30 "figi\_code": "BBG000B9XRY4", 31 "figi\_instrument": { 32 "figi\_code": "BBG000B9Y5X2", 33 "figi\_share\_class": "BBG001S5N8V8" 34 }, 35 "currencies": \[\ \ 36\ \ {\ \ 37\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 38\ \ "code": "USD",\ \ 39\ \ "name": "US Dollar"\ \ 40\ \ }\ \ 41\ \ \] 42 }, 43 "option\_symbol": { 44 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 45 "ticker": "AAPL 261218C00240000", 46 "option\_type": "CALL", 47 "strike\_price": 240, 48 "expiration\_date": "2026-12-18", 49 "is\_mini\_option": false, 50 "underlying\_symbol": { 51 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 52 "symbol": "SPY", 53 "raw\_symbol": "VAB", 54 "description": "SPDR S&P 500 ETF Trust", 55 "currency": { 56 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 57 "code": "USD", 58 "name": "US Dollar" 59 }, 60 "exchange": { 61 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 62 "code": "ARCX", 63 "mic\_code": "ARCA", 64 "name": "NYSE ARCA", 65 "timezone": "America/New\_York", 66 "start\_time": "09:30:00", 67 "close\_time": "16:00:00", 68 "suffix": "None", 69 "allows\_cryptocurrency\_symbols": false 70 }, 71 "type": { 72 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 73 "code": "cs", 74 "description": "Common Stock", 75 "is\_supported": true 76 }, 77 "figi\_code": "BBG000B9XRY4", 78 "figi\_instrument": { 79 "figi\_code": "BBG000B9Y5X2", 80 "figi\_share\_class": "BBG001S5N8V8" 81 }, 82 "currencies": \[\ \ 83\ \ {\ \ 84\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 85\ \ "code": "USD",\ \ 86\ \ "name": "US Dollar"\ \ 87\ \ }\ \ 88\ \ \] 89 } 90 }, 91 "quote\_universal\_symbol": { 92 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 93 "symbol": "VAB.TO", 94 "raw\_symbol": "VAB", 95 "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF", 96 "currency": { 97 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 98 "code": "USD", 99 "name": "US Dollar" 100 }, 101 "exchange": { 102 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 103 "code": "TSX", 104 "mic\_code": "XTSE", 105 "name": "Toronto Stock Exchange", 106 "timezone": "America/New\_York", 107 "start\_time": "09:30:00", 108 "close\_time": "16:00:00", 109 "suffix": ".TO" 110 }, 111 "type": { 112 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 113 "code": "cs", 114 "description": "Common Stock", 115 "is\_supported": true 116 }, 117 "figi\_code": "BBG000B9XRY4", 118 "figi\_instrument": { 119 "figi\_code": "BBG000B9Y5X2", 120 "figi\_share\_class": "BBG001S5N8V8" 121 }, 122 "currencies": \[\ \ 123\ \ {\ \ 124\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 125\ \ "code": "USD",\ \ 126\ \ "name": "US Dollar"\ \ 127\ \ }\ \ 128\ \ \] 129 }, 130 "quote\_currency": { 131 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 132 "code": "USD", 133 "name": "US Dollar" 134 }, 135 "action": "string", 136 "total\_quantity": "100", 137 "open\_quantity": "10", 138 "canceled\_quantity": "10", 139 "filled\_quantity": "80", 140 "execution\_price": 12.34, 141 "limit\_price": 12.34, 142 "stop\_price": 12.5, 143 "order\_type": "Market", 144 "time\_in\_force": "string", 145 "time\_placed": "2024-07-30T22:51:49.746Z", 146 "time\_updated": "2024-08-05T00:05:57.409Z", 147 "time\_executed": "2024-08-05T00:05:57.409Z", 148 "expiry\_date": "2024-08-05T00:05:57.409Z", 149 "symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3", 150 "child\_brokerage\_order\_ids": { 151 "take\_profit\_order\_id": "12345678", 152 "stop\_loss\_order\_id": "12345678" 153 } 154 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Place crypto order / SnapTrade Trading Place crypto order ------------------ post `https://api.snaptrade.com/api/v1/accounts/{accountId}/trading/crypto` Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order. #### Execute an API Request Path `accountId``string (format: uuid)``required` Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Request Body `instrument``object``required` `symbol``string``required` The instrument's trading ticker symbol `type``string``required` The instrument's type `side``string``required` The action describes the intent or side of a trade. This is either `BUY` or `SELL`. `type``string``required` The type of order to place. `time_in_force``string``required` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. * `GTD` - Good Til Date. The order is valid until the specified date. `amount``string (format: decimal)``required` The amount of the base currency to buy or sell. `limit_price``string (format: decimal)` The limit price. Required if the order type is LIMIT, STOP\_LOSS\_LIMIT or TAKE\_PROFIT\_LIMIT. `stop_price``string (format: decimal)` The stop price. Required if the order type is STOP\_LOSS\_MARKET, STOP\_LOSS\_LIMIT, TAKE\_PROFIT\_MARKET or TAKE\_PROFIT\_LIMIT. `post_only``boolean` Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. Unset False True `expiration_date``string (format: date-time)` The expiration date of the order. Required if the time\_in\_force is GTD. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400500 `object` Expand all... `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `order``object` Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records. Show properties `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `status``string` Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. `universal_symbol``object` Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `option_symbol``object` Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_universal_symbol``object` Quote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_currency``object` Quote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `action``string` The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. * BUY * SELL * BUY\_COVER * SELL\_SHORT * BUY\_OPEN * BUY\_CLOSE * SELL\_OPEN * SELL\_CLOSE `total_quantity``string or null` The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares. `open_quantity``string or null` The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares. `canceled_quantity``string or null` The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares. `filled_quantity``string or null` The number of shares or contracts that have been filled. Can be a decimal number for fractional shares. `execution_price``number or null` The price at which the order was executed. `limit_price``number or null` The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. `stop_price``number or null` The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. `order_type``string or null` The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value. `time_in_force``string` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value. * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. * `GTD` - Good Til Date. The order is valid until the specified date. * `MOO` - Market On Open. The order is to be executed at the day's opening price. * `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. `time_placed``string (format: date-time)` The time the order was placed. This is the time the order was submitted to the brokerage. `time_updated``string (format: date-time) or null` The time the order was last updated in the brokerage system. This value is not always available from the brokerage. `time_executed``string (format: date-time) or null` The time the order was executed in the brokerage system. This value is not always available from the brokerage. `expiry_date``string (format: date-time) or null` The time the order expires. This value is not always available from the brokerage. `symbol``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `child_brokerage_order_ids``object or null` Show properties `take_profit_order_id``string` The brokerage order ID for the take profit leg of the bracket order `stop_loss_order_id``string` The brokerage order ID for the stop loss leg of the bracket order 1 { 2 "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e", 3 "order": { 4 "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e", 5 "status": "NONE", 6 "universal\_symbol": { 7 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 8 "symbol": "VAB.TO", 9 "raw\_symbol": "VAB", 10 "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF", 11 "currency": { 12 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 13 "code": "USD", 14 "name": "US Dollar" 15 }, 16 "exchange": { 17 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 18 "code": "TSX", 19 "mic\_code": "XTSE", 20 "name": "Toronto Stock Exchange", 21 "timezone": "America/New\_York", 22 "start\_time": "09:30:00", 23 "close\_time": "16:00:00", 24 "suffix": ".TO" 25 }, 26 "type": { 27 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 28 "code": "cs", 29 "description": "Common Stock", 30 "is\_supported": true 31 }, 32 "figi\_code": "BBG000B9XRY4", 33 "figi\_instrument": { 34 "figi\_code": "BBG000B9Y5X2", 35 "figi\_share\_class": "BBG001S5N8V8" 36 }, 37 "currencies": \[\ \ 38\ \ {\ \ 39\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 40\ \ "code": "USD",\ \ 41\ \ "name": "US Dollar"\ \ 42\ \ }\ \ 43\ \ \] 44 }, 45 "option\_symbol": { 46 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 47 "ticker": "AAPL 261218C00240000", 48 "option\_type": "CALL", 49 "strike\_price": 240, 50 "expiration\_date": "2026-12-18", 51 "is\_mini\_option": false, 52 "underlying\_symbol": { 53 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 54 "symbol": "SPY", 55 "raw\_symbol": "VAB", 56 "description": "SPDR S&P 500 ETF Trust", 57 "currency": { 58 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 59 "code": "USD", 60 "name": "US Dollar" 61 }, 62 "exchange": { 63 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 64 "code": "ARCX", 65 "mic\_code": "ARCA", 66 "name": "NYSE ARCA", 67 "timezone": "America/New\_York", 68 "start\_time": "09:30:00", 69 "close\_time": "16:00:00", 70 "suffix": "None", 71 "allows\_cryptocurrency\_symbols": false 72 }, 73 "type": { 74 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 75 "code": "cs", 76 "description": "Common Stock", 77 "is\_supported": true 78 }, 79 "figi\_code": "BBG000B9XRY4", 80 "figi\_instrument": { 81 "figi\_code": "BBG000B9Y5X2", 82 "figi\_share\_class": "BBG001S5N8V8" 83 }, 84 "currencies": \[\ \ 85\ \ {\ \ 86\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 87\ \ "code": "USD",\ \ 88\ \ "name": "US Dollar"\ \ 89\ \ }\ \ 90\ \ \] 91 } 92 }, 93 "quote\_universal\_symbol": { 94 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 95 "symbol": "VAB.TO", 96 "raw\_symbol": "VAB", 97 "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF", 98 "currency": { 99 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 100 "code": "USD", 101 "name": "US Dollar" 102 }, 103 "exchange": { 104 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 105 "code": "TSX", 106 "mic\_code": "XTSE", 107 "name": "Toronto Stock Exchange", 108 "timezone": "America/New\_York", 109 "start\_time": "09:30:00", 110 "close\_time": "16:00:00", 111 "suffix": ".TO" 112 }, 113 "type": { 114 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 115 "code": "cs", 116 "description": "Common Stock", 117 "is\_supported": true 118 }, 119 "figi\_code": "BBG000B9XRY4", 120 "figi\_instrument": { 121 "figi\_code": "BBG000B9Y5X2", 122 "figi\_share\_class": "BBG001S5N8V8" 123 }, 124 "currencies": \[\ \ 125\ \ {\ \ 126\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 127\ \ "code": "USD",\ \ 128\ \ "name": "US Dollar"\ \ 129\ \ }\ \ 130\ \ \] 131 }, 132 "quote\_currency": { 133 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 134 "code": "USD", 135 "name": "US Dollar" 136 }, 137 "action": "string", 138 "total\_quantity": "100", 139 "open\_quantity": "10", 140 "canceled\_quantity": "10", 141 "filled\_quantity": "80", 142 "execution\_price": 12.34, 143 "limit\_price": 12.34, 144 "stop\_price": 12.5, 145 "order\_type": "Market", 146 "time\_in\_force": "string", 147 "time\_placed": "2024-07-30T22:51:49.746Z", 148 "time\_updated": "2024-08-05T00:05:57.409Z", 149 "time\_executed": "2024-08-05T00:05:57.409Z", 150 "expiry\_date": "2024-08-05T00:05:57.409Z", 151 "symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3", 152 "child\_brokerage\_order\_ids": { 153 "take\_profit\_order\_id": "12345678", 154 "stop\_loss\_order\_id": "12345678" 155 } 156 } 157 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) --- # Replace order / SnapTrade Trading Replace order ------------- post `https://api.snaptrade.com/api/v1/accounts/{accountId}/trading/replace` Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order's brokerage\_order\_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages #### Execute an API Request Path `accountId``string (format: uuid)``required` The ID of the account to execute the trade on. Query `userId``string``required` SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable. `userSecret``string``required` SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](https://docs.snaptrade.com/reference/Authentication/Authentication_resetSnapTradeUserSecret) . Request Body `brokerage_order_id``string``required` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `action``string``required` The action describes the intent or side of a trade. This is either `BUY` or `SELL`. `order_type``string``required` The type of order to place. * For `Limit` and `StopLimit` orders, the `price` field is required. * For `Stop` and `StopLimit` orders, the `stop` field is required. `time_in_force``string``required` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. `price``number or null` The limit price for `Limit` and `StopLimit` orders. `symbol``string` The security's trading ticker symbol `stop``number or null` The price at which a stop order is triggered for `Stop` and `StopLimit` orders. `units``number or null` Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided. Authorization clientId \* consumerKey \* Request TypeScriptPython Installation [GitHub](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/typescript/README.md) [npm](https://www.npmjs.com/package/snaptrade-typescript-sdk) $ npm install snaptrade-typescript-sdk 1 Loading... CopyCopied! Send #### Response fields 200400403500 `object` Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records. Expand all... `brokerage_order_id``string` Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system. `status``string` Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. `universal_symbol``object` Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `option_symbol``object` Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated. Show properties `id``string (format: uuid)` Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `ticker``string` The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option. `option_type``string` The type of option. Either "CALL" or "PUT". `strike_price``number` The option strike price. `expiration_date``string (format: date)` The option expiration date. `is_mini_option``boolean` Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100. `underlying_symbol``object` Symbol object for the underlying security of an option. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` `code``string` `mic_code``string` `name``string` `timezone``string` `start_time``string` `close_time``string` `suffix``string or null` `allows_cryptocurrency_symbols``boolean` `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_universal_symbol``object` Quote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote. Show properties `id``string (format: uuid)` Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls. `symbol``string` The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html) (click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. `raw_symbol``string` The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is "VAB.TO", then `raw_symbol` is "VAB". `description``string or null` A human-readable description of the security. This is usually the company name or ETF name. `currency``object` The currency in which the security is traded. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `exchange``object` The exchange on which the security is listed and traded. Show properties `id``string (format: uuid)` Unique ID for the exchange in SnapTrade. `code``string` A short name for the exchange. For standardized exchange code, please us the `mic_code` field. `mic_code``string` The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange. `name``string` The full name of the exchange. `timezone``string` The timezone for the trading hours (`start_time` and `close_time`) of the exchange. `start_time``string` The time when the exchange opens for trading. `close_time``string` The time when the exchange closes for trading. `suffix``string or null` The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail. `type``object` The type of security. For example, "Common Stock" or "ETF". Show properties `id``string (format: uuid)` Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls. `code``string` A short code representing the security type. For example, "cs" for Common Stock. Here are some common values: * `ad` - ADR * `bnd` - Bond * `cs` - Common Stock * `cef` - Closed End Fund * `crypto` - Cryptocurrency * `et` - ETF * `oef` - Open Ended Fund * `ps` - Preferred Stock * `rt` - Right * `struct` - Structured Product * `ut` - Unit * `wi` - When Issued * `wt` - Warrant `description``string` A human-readable description of the security type. For example, "Common Stock" or "ETF". `is_supported``boolean` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. `figi_code``string or null` 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. This value should be the same as the `figi_code` in the `figi_instrument` child property. `figi_instrument``object or null` Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information. Show properties `figi_code``string or null` 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. `figi_share_class``string or null` 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. `currencies``array of objects` Deprecated Refrain from usage of this field This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `quote_currency``object` Quote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote. Show properties `id``string (format: uuid)` Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade. `code``string` The ISO-4217 currency code for the currency. `name``string` A human-friendly name of the currency. `action``string` The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. * BUY * SELL * BUY\_COVER * SELL\_SHORT * BUY\_OPEN * BUY\_CLOSE * SELL\_OPEN * SELL\_CLOSE `total_quantity``string or null` The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares. `open_quantity``string or null` The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares. `canceled_quantity``string or null` The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares. `filled_quantity``string or null` The number of shares or contracts that have been filled. Can be a decimal number for fractional shares. `execution_price``number or null` The price at which the order was executed. `limit_price``number or null` The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. `stop_price``number or null` The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. `order_type``string or null` The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value. `time_in_force``string` The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value. * `Day` - Day. The order is valid only for the trading day on which it is placed. * `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. * `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. * `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. * `GTD` - Good Til Date. The order is valid until the specified date. * `MOO` - Market On Open. The order is to be executed at the day's opening price. * `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. `time_placed``string (format: date-time)` The time the order was placed. This is the time the order was submitted to the brokerage. `time_updated``string (format: date-time) or null` The time the order was last updated in the brokerage system. This value is not always available from the brokerage. `time_executed``string (format: date-time) or null` The time the order was executed in the brokerage system. This value is not always available from the brokerage. `expiry_date``string (format: date-time) or null` The time the order expires. This value is not always available from the brokerage. `symbol``string (format: uuid)` Deprecated Refrain from usage of this field A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change. `child_brokerage_order_ids``object or null` Show properties `take_profit_order_id``string` The brokerage order ID for the take profit leg of the bracket order `stop_loss_order_id``string` The brokerage order ID for the stop loss leg of the bracket order 1 { 2 "brokerage\_order\_id": "66a033fa-da74-4fcf-b527-feefdec9257e", 3 "status": "NONE", 4 "universal\_symbol": { 5 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 6 "symbol": "VAB.TO", 7 "raw\_symbol": "VAB", 8 "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF", 9 "currency": { 10 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 11 "code": "USD", 12 "name": "US Dollar" 13 }, 14 "exchange": { 15 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 16 "code": "TSX", 17 "mic\_code": "XTSE", 18 "name": "Toronto Stock Exchange", 19 "timezone": "America/New\_York", 20 "start\_time": "09:30:00", 21 "close\_time": "16:00:00", 22 "suffix": ".TO" 23 }, 24 "type": { 25 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 26 "code": "cs", 27 "description": "Common Stock", 28 "is\_supported": true 29 }, 30 "figi\_code": "BBG000B9XRY4", 31 "figi\_instrument": { 32 "figi\_code": "BBG000B9Y5X2", 33 "figi\_share\_class": "BBG001S5N8V8" 34 }, 35 "currencies": \[\ \ 36\ \ {\ \ 37\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 38\ \ "code": "USD",\ \ 39\ \ "name": "US Dollar"\ \ 40\ \ }\ \ 41\ \ \] 42 }, 43 "option\_symbol": { 44 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 45 "ticker": "AAPL 261218C00240000", 46 "option\_type": "CALL", 47 "strike\_price": 240, 48 "expiration\_date": "2026-12-18", 49 "is\_mini\_option": false, 50 "underlying\_symbol": { 51 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 52 "symbol": "SPY", 53 "raw\_symbol": "VAB", 54 "description": "SPDR S&P 500 ETF Trust", 55 "currency": { 56 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 57 "code": "USD", 58 "name": "US Dollar" 59 }, 60 "exchange": { 61 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 62 "code": "ARCX", 63 "mic\_code": "ARCA", 64 "name": "NYSE ARCA", 65 "timezone": "America/New\_York", 66 "start\_time": "09:30:00", 67 "close\_time": "16:00:00", 68 "suffix": "None", 69 "allows\_cryptocurrency\_symbols": false 70 }, 71 "type": { 72 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 73 "code": "cs", 74 "description": "Common Stock", 75 "is\_supported": true 76 }, 77 "figi\_code": "BBG000B9XRY4", 78 "figi\_instrument": { 79 "figi\_code": "BBG000B9Y5X2", 80 "figi\_share\_class": "BBG001S5N8V8" 81 }, 82 "currencies": \[\ \ 83\ \ {\ \ 84\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 85\ \ "code": "USD",\ \ 86\ \ "name": "US Dollar"\ \ 87\ \ }\ \ 88\ \ \] 89 } 90 }, 91 "quote\_universal\_symbol": { 92 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 93 "symbol": "VAB.TO", 94 "raw\_symbol": "VAB", 95 "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF", 96 "currency": { 97 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 98 "code": "USD", 99 "name": "US Dollar" 100 }, 101 "exchange": { 102 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 103 "code": "TSX", 104 "mic\_code": "XTSE", 105 "name": "Toronto Stock Exchange", 106 "timezone": "America/New\_York", 107 "start\_time": "09:30:00", 108 "close\_time": "16:00:00", 109 "suffix": ".TO" 110 }, 111 "type": { 112 "id": "2bcd7cc3-e922-4976-bce1-9858296801c3", 113 "code": "cs", 114 "description": "Common Stock", 115 "is\_supported": true 116 }, 117 "figi\_code": "BBG000B9XRY4", 118 "figi\_instrument": { 119 "figi\_code": "BBG000B9Y5X2", 120 "figi\_share\_class": "BBG001S5N8V8" 121 }, 122 "currencies": \[\ \ 123\ \ {\ \ 124\ \ "id": "87b24961-b51e-4db8-9226-f198f6518a89",\ \ 125\ \ "code": "USD",\ \ 126\ \ "name": "US Dollar"\ \ 127\ \ }\ \ 128\ \ \] 129 }, 130 "quote\_currency": { 131 "id": "87b24961-b51e-4db8-9226-f198f6518a89", 132 "code": "USD", 133 "name": "US Dollar" 134 }, 135 "action": "string", 136 "total\_quantity": "100", 137 "open\_quantity": "10", 138 "canceled\_quantity": "10", 139 "filled\_quantity": "80", 140 "execution\_price": 12.34, 141 "limit\_price": 12.34, 142 "stop\_price": 12.5, 143 "order\_type": "Market", 144 "time\_in\_force": "string", 145 "time\_placed": "2024-07-30T22:51:49.746Z", 146 "time\_updated": "2024-08-05T00:05:57.409Z", 147 "time\_executed": "2024-08-05T00:05:57.409Z", 148 "expiry\_date": "2024-08-05T00:05:57.409Z", 149 "symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3", 150 "child\_brokerage\_order\_ids": { 151 "take\_profit\_order\_id": "12345678", 152 "stop\_loss\_order\_id": "12345678" 153 } 154 } [](https://snaptrade.com/) [Made with Konfig](https://konfigthis.com/) ---