SnapTrade

https://docs.snaptrade.com
Admin
SnapTrade is an API platform that enables developers to integrate brokerage connections, access...
Tokens:559,728
Snippets:3,318
Trust Score:8.5
Update:2 days ago
Show doc for...
Tokens:
Raw
### Place Force Order with TypeScript SDK

Source: https://docs.snaptrade.com/reference/Trading/Trading_placeForceOrder

Example of placing a force order using the snaptrade-typescript-sdk. Requires installing the package via npm. The example initializes the Snaptrade client with commercial API key credentials and calls trading.placeForceOrder with order details such as symbol, order_type, time_in_force, and price.

```TypeScript
import {
  Snaptrade,
  SnaptradeAuth,
} from "snaptrade-typescript-sdk";

const snaptrade = new Snaptrade({
  auth: SnaptradeAuth.commercialApiKey({
    consumerKey: "CONSUMER_KEY",
    clientId: "CLIENT_ID",
  }),
});

const response =
  await snaptrade.trading.placeForceOrder({
    userId: "USER_ID",
    userSecret: "USER_SECRET",
    account_id:
      "917c8734-8470-4a3e-a18f-57c3f2ee6631",
    action: "ACTION",
    symbol: "AAPL",
    order_type: "Market",
    time_in_force: "Day",
    trading_session: "REGULAR",
    expiry_date: "2026-08-21T23:27:55.027Z",
    price: 31.33,
    stop: 31.33,
  });
console.log(response.data);
```

--------------------------------

### Install snaptrade-typescript-sdk

Source: https://docs.snaptrade.com/reference/API%20Status/ApiStatus_check

Install the TypeScript SDK via npm before using the API status check.

```bash
npm install snaptrade-typescript-sdk
```

--------------------------------

### Create Next.js project and install SnapTrade SDK

Source: https://docs.snaptrade.com/docs/build-with-ai.md

Initializes a new Next.js project with TypeScript and installs the snaptrade-typescript-sdk package. Run these commands in an empty directory.

```bash
npx create-next-app@latest my-investing-dashboard --typescript
cd my-investing-dashboard
npm install snaptrade-typescript-sdk
```

--------------------------------

### JSON: Example response for get crypto pair quote

Source: https://docs.snaptrade.com/reference/Trading/Trading_getCryptocurrencyPairQuote

Example response object with bid, ask, mid, and timestamp fields. The bid and ask are decimal strings, and the timestamp is in ISO 8601 format.

```JSON
{
  "bid": "123.45",
  "ask": "123.45",
  "mid": "123.45",
  "timestamp": "2024-01-24T15:00:00.000Z"
}
```

--------------------------------

### Python: Get Account Activities

Source: https://docs.snaptrade.com/reference/Account%20Information/AccountInformation_getAccountActivities.md

Uses the snaptrade_client SDK to call account_information.get_account_activities with the same parameters as the TypeScript example. The response body is printed with pprint.

```python
from pprint import pprint
from snaptrade_client import SnapTrade, SnapTradeAuth

snaptrade = SnapTrade(
    auth=SnapTradeAuth.commercial_api_key(
        consumer_key="CONSUMER_KEY",
        client_id="CLIENT_ID",
    )
)

response = snaptrade.account_information.get_account_activities(
    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
    start_date="2022-01-24T00:00:00.000Z",
    end_date="2022-01-24T00:00:00.000Z",
    type="BUY,SELL,DIVIDEND",
    user_id="USER_ID",
    user_secret="USER_SECRET"
)
pprint(response.body)
```

--------------------------------

### Python: Commercial API Key Authentication Workflow

Source: https://docs.snaptrade.com/docs/authentication-methods.md

Initialize the SnapTrade SDK with Commercial API key credentials, register a user, generate a connection URL, and fetch account data. Requires SNAPTRADE_CLIENT_ID and SNAPTRADE_CONSUMER_KEY environment variables. Keep consumerKey and userSecret secure.

```python
import os
from snaptrade_client import SnapTrade, SnapTradeAuth

snaptrade = SnapTrade(
    # Commercial auth is for apps managing many SnapTrade users.
    auth=SnapTradeAuth.commercial_api_key(
        client_id=os.environ["SNAPTRADE_CLIENT_ID"],
        consumer_key=os.environ["SNAPTRADE_CONSUMER_KEY"],
    )
)

# This user is one of your app's end users.
user_id = "snaptrade-user-123"

registered_user = snaptrade.authentication.register_snap_trade_user(
    user_id=user_id,
)

user_secret = registered_user.body["userSecret"]

# Generate connection URL.
login = snaptrade.authentication.login_snap_trade_user(
    user_id=user_id,
    user_secret=user_secret,
)

print("Send this Connection Portal URL to your user:", login.body["redirectURI"])

# After the user connects an account, you can fetch their account data.
accounts = snaptrade.account_information.list_user_accounts(
    # Commercial account-data calls include the user's credentials.
    user_id=user_id,
    user_secret=user_secret,
)

activities = snaptrade.account_information.get_account_activities(
    account_id=accounts.body[0]["id"],
    user_id=user_id,
    user_secret=user_secret,
    start_date="2026-01-01",
    end_date="2026-01-31",
    limit=100,
)

print(activities.body)
```

--------------------------------

### GET /snapTrade/partners

Source: https://docs.snaptrade.com/reference/Reference%20Data/ReferenceData_getPartnerInfo.md

This endpoint is documented in the SnapTrade API. The source text provides error response examples for the endpoint, including 404 and 500 status codes.

```APIDOC
## GET /snapTrade/partners

### Description
This endpoint is part of the SnapTrade API. The provided documentation includes error responses for the endpoint.

### Method
GET

### Endpoint
/snapTrade/partners

### Response
#### Error Response (404)
- **default_detail** (string) - Example: "The requested resource does not exist."
- **default_code** (string) - Example: "1011"

#### Error Response Example (404)
{
  "default_detail": "The requested resource does not exist.",
  "default_code": "1011"
}

#### Error Response (500)
- **description** (string) - "Unexpected Error"

#### Error Response Example (500)
{
  "description": "Unexpected Error"
}
```

--------------------------------

### Start the development server with npm run dev

Source: https://docs.snaptrade.com/docs/build-with-ai.md

Run this command in the project root to start the development server. Verify the dashboard against the checklist before relying on it.

```bash
npm run dev
```

--------------------------------

### Place Equity Order in Python using snaptrade_client

Source: https://docs.snaptrade.com/reference/Trading/Trading_placeForceOrder.md

Python example using the SnapTrade client from 'snaptrade_client'. It calls trading.place_force_order with the same parameters as the TypeScript example, including account_id, action, symbol, order_type, time_in_force, trading_session, expiry_date, price, stop, user_id, and user_secret. The response body is printed with pprint.

```Python
from pprint import pprint
from snaptrade_client import SnapTrade, SnapTradeAuth

snaptrade = SnapTrade(
    auth=SnapTradeAuth.commercial_api_key(
        consumer_key="CONSUMER_KEY",
        client_id="CLIENT_ID",
    )
)

response = snaptrade.trading.place_force_order(
    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
    action="ACTION",
    symbol="AAPL",
    order_type="Market",
    time_in_force="Day",
    trading_session="REGULAR",
    expiry_date="2026-08-21T23:27:55.027Z",
    price=31.33,
    stop=31.33,
    user_id="USER_ID",
    user_secret="USER_SECRET"
)
pprint(response.body)
```

--------------------------------

### GET /api/v1/accounts/<account_id>/activities (Personal API key)

Source: https://docs.snaptrade.com/docs/authentication-methods.md

Example of a direct HTTP request signed with a Personal API key. Includes clientId, timestamp, and Signature header, but omits user credentials.

```APIDOC
## [GET] /api/v1/accounts/<account_id>/activities

### Description
Retrieves account activities for the SnapTrade account associated with the Personal API key. This request is signed with a Personal API key and does not include user credentials.

### Method
GET

### Endpoint
/api/v1/accounts/<account_id>/activities

### Parameters
#### Query Parameters
- **clientId** (string) - Required - The Personal API key client ID.
- **timestamp** (integer) - Required - Unix timestamp for request signing.

### Headers
- **Signature** (string) - Required - The request signature.

### Request Example
```http
GET /api/v1/accounts/<account_id>/activities?clientId=<client_id>&timestamp=<unix_timestamp>
Signature: <signature>
```

### Response
#### Success Response (200)
- **activities** (array) - List of account activities.

#### Response Example
```json
{
  "activities": []
}
```
```

--------------------------------

### TypeScript: Commercial API Key Authentication Workflow

Source: https://docs.snaptrade.com/docs/authentication-methods.md

Initialize the SnapTrade SDK with Commercial API key credentials, register a user, generate a connection URL, and fetch account data. Requires SNAPTRADE_CLIENT_ID and SNAPTRADE_CONSUMER_KEY environment variables. Keep consumerKey and userSecret secure.

```typescript
import { Snaptrade, SnaptradeAuth } from "snaptrade-typescript-sdk";

const snaptrade = new Snaptrade({
  // Commercial auth is for apps managing many SnapTrade users.
  auth: SnaptradeAuth.commercialApiKey({
    clientId: process.env.SNAPTRADE_CLIENT_ID!,
    consumerKey: process.env.SNAPTRADE_CONSUMER_KEY!,
  }),
});

// This user is one of your app's end users.
const userId = "snaptrade-user-123";

const registeredUser = await snaptrade.authentication.registerSnapTradeUser({
  userId,
});

const userSecret = registeredUser.data.userSecret!;

// Generate connection URL.
const login = await snaptrade.authentication.loginSnapTradeUser({
  userId,
  userSecret,
});

console.log("Send this Connection Portal URL to your user:", login.data.redirectURI);

// After the user connects an account, you can fetch their account data.
const accounts = await snaptrade.accountInformation.listUserAccounts({
  // Commercial account-data calls include the user's credentials.
  userId,
  userSecret,
});

const activities = await snaptrade.accountInformation.getAccountActivities({
  accountId: accounts.data[0].id!,
  userId,
  userSecret,
  startDate: "2026-01-01",
  endDate: "2026-01-31",
  limit: 100,
});

console.log(activities.data);
```

--------------------------------

### GET /api/v1/accounts/<account_id>/activities (Commercial API key)

Source: https://docs.snaptrade.com/docs/authentication-methods.md

Example of a direct HTTP request signed with a Commercial API key. Includes clientId, timestamp, Signature header, and user credentials for user-scoped endpoints.

```APIDOC
## [GET] /api/v1/accounts/<account_id>/activities

### Description
Retrieves account activities for a SnapTrade user. This request is signed with a Commercial API key and includes user credentials.

### Method
GET

### Endpoint
/api/v1/accounts/<account_id>/activities

### Parameters
#### Query Parameters
- **clientId** (string) - Required - The Commercial API key client ID.
- **timestamp** (integer) - Required - Unix timestamp for request signing.
- **userId** (string) - Required - The SnapTrade user ID.
- **userSecret** (string) - Required - The SnapTrade user secret.

### Headers
- **Signature** (string) - Required - The request signature.

### Request Example
```http
GET /api/v1/accounts/<account_id>/activities?clientId=<client_id>&timestamp=<unix_timestamp>&userId=<user_id>&userSecret=<user_secret>
Signature: <signature>
```

### Response
#### Success Response (200)
- **activities** (array) - List of account activities.

#### Response Example
```json
{
  "activities": []
}
```
```

--------------------------------

### TypeScript SDK: Place Complex Order

Source: https://docs.snaptrade.com/reference/Trading/Trading_placeComplexOrder

Example using the snaptrade-typescript-sdk to place a complex order with commercial API key authentication. The request includes accountId, userId, userSecret, order type 'OTO', and an orders array with a TRIGGER order. Requires npm install snaptrade-typescript-sdk.

```TypeScript
import {
  Snaptrade,
  SnaptradeAuth,
} from "snaptrade-typescript-sdk";

const snaptrade = new Snaptrade({
  auth: SnaptradeAuth.commercialApiKey({
    consumerKey: "CONSUMER_KEY",
    clientId: "CLIENT_ID",
  }),
});

const response =
  await snaptrade.trading.placeComplexOrder({
    accountId:
      "917c8734-8470-4a3e-a18f-57c3f2ee6631",
    userId: "USER_ID",
    userSecret: "USER_SECRET",
    type: "OTO",
    orders: [
      {
        order_role: "TRIGGER",
        action: "ACTION",
        instrument: {
          symbol: "AAPL",
          type: "TYPE",
        },
        order_type: "Market",
        units: 1,
        time_in_force: "Day",
        price: 31.33,
        stop: 29.5,
      },
    ],
  });
console.log(response.data);
```

--------------------------------

### Python: list_connection_accounts

Source: https://docs.snaptrade.com/reference/Connections/Connections_listConnectionAccounts.md

Initializes the SnapTrade client with commercial API key credentials and calls list_connection_accounts with a connection ID, user ID, and user secret. Prints the response body using pprint.

```python
from pprint import pprint
from snaptrade_client import SnapTrade, SnapTradeAuth

snaptrade = SnapTrade(
    auth=SnapTradeAuth.commercial_api_key(
        consumer_key="CONSUMER_KEY",
        client_id="CLIENT_ID",
    )
)

response = snaptrade.connections.list_connection_accounts(
    connection_id="87b24961-b51e-4db8-9226-f198f6518a89",
    user_id="USER_ID",
    user_secret="USER_SECRET"
)
pprint(response.body)
```

--------------------------------

### Preview Crypto Order with TypeScript SDK

Source: https://docs.snaptrade.com/reference/Trading/Trading_previewCryptoOrder

Uses the Snaptrade TypeScript SDK to call trading.previewCryptoOrder with commercial API key authentication. Requires npm install snaptrade-typescript-sdk and valid credentials (consumerKey, clientId, userId, userSecret). The example passes a BTC instrument, side, type, time_in_force, and amount.

```typescript
import {
  Snaptrade,
  SnaptradeAuth,
} from "snaptrade-typescript-sdk";

const snaptrade = new Snaptrade({
  auth: SnaptradeAuth.commercialApiKey({
    consumerKey: "CONSUMER_KEY",
    clientId: "CLIENT_ID",
  }),
});

const response =
  await snaptrade.trading.previewCryptoOrder({
    accountId:
      "917c8734-8470-4a3e-a18f-57c3f2ee6631",
    userId: "USER_ID",
    userSecret: "XXXXXXXXXXX",
    instrument: { symbol: "BTC", type: "TYPE" },
    side: "SIDE",
    type: "TYPE",
    time_in_force: "TIME_IN_FORCE",
    amount: "123.45",
  });
console.log(response.data);
```
Tokens:
Raw