Search
Ctrl
K
API Reference
Documentation
API Reference
Demos
SDKs
Search
Ctrl
K
API Status
Get API Status
get
Authentication
Create SnapTrade user
post
Login user & generate connection link
post
List SnapTrade users
get
Delete SnapTrade user
delete
Generate encrypted JWT token
get
Connections
List all brokerage authorizations for the user
get
Delete brokerage authorization
delete
Get brokerage authorization details
get
Account Information
List accounts
get
List balances, positions and orders for the specified account
get
Return details of a specific investment account
get
List account balances
get
List account positions
get
List account orders
get
Trading
Get symbol quotes
get
Check impact of trades on account.
post
Place order
post
Place a trade with NO validation.
post
Place a OCO (One Cancels Other) order
post
Cancel open order in account
post
Transactions And Reporting
Get transaction history for a user
get
Reference Data
Get metadata related to Snaptrade partner
get
Search for symbols available in an account
post
List of all brokerage authorization types
get
List currencies
get
List currency exchange rates
get
Return the exchange rate of a currency pair
get
List exchanges
get
List of all security types
get
Search for symbols
post
Get details of a symbol by the ticker
get
Options
Get the options holdings in the account
get
Get the options chain
get
Creates an option strategy object that will be used to place an option strategy order
post
Get latest market data of option strategy
get
Place an option strategy order on the brokerage
post
Authentication
Create SnapTrade user
post
https://api.snaptrade.com/api/v1/snapTrade/registerUser
Request Body
userId
string
SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
Responses
200 OK
Success
Successfully registered user
Example
JSON Schema
400 Bad Request
Error
Bad Request. Could be caused by various reasons. Error message is provided in response
Example
JSON Schema
404 Not Found
Error
Invalid SnapTrade Client ID provided in query
Example
JSON Schema
500 Internal Server Error
Error
Unexpected error
Example
JSON Schema
Made with Konfig
Authorization
clientId
*
consumerKey
*
Request
TypeScript
Python
Installation
GitHub
npm
$
npm install snaptrade-typescript-sdk
1
Loading
...
Copy
Copied!
Send
Made with Konfig