List all connections / SnapTrade

List all connections

get

https://api.snaptrade.com/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

Authentication Method

Use commercial authentication when acting on behalf of your application and passing end-user credentials with requests that require them.

Credentials

clientId

consumerKey

userId

userSecret

Request

Installation

GitHub npm

npm install snaptrade-typescript-sdk

1
import {
2
  Snaptrade,
3
  SnaptradeAuth,
4
} from "snaptrade-typescript-sdk";
5

6
const snaptrade = new Snaptrade({
7
  auth: SnaptradeAuth.commercialApiKey({
8
    consumerKey: "CONSUMER_KEY",
9
    clientId: "CLIENT_ID",
10
  }),
11
});
12

13
const response =
14
  await snaptrade.connections.listBrokerageAuthorizations(
15
    {
16
      userId: "USER_ID",
17
      userSecret: "USER_SECRET",
18
    },
19
  );
20
console.log(response.data);

Response fields

array of objects

A list of all connections for the specified user.

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.

idstring (format: uuid)

Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.

created_datestring (format: date-time)

Timestamp of when the connection was established in SnapTrade.

brokerageobject

Describes a brokerage that SnapTrade supports.

namestring

A short, human-readable name for the connection.

typestring

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.

disabledboolean

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 on how to fix a disabled connection.

disabled_datestring (format: date-time) or null

Timestamp of when the connection was disabled in SnapTrade.

metaobject

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_datestring (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_payoutboolean

Whether the connection is eligible for a payout. This is an experimental field that is NOT generally available for all partners. Do not use in production without speaking to the SnapTrade team.

data_freshness_modestring

Possible values include:

realtime
delayed

Indicates whether SnapTrade will provide delayed or realtime data for this connection. delayed means SnapTrade uses cached data for the connection because of the customer's plan, or because of brokerage limitations. realtime means SnapTrade retrieves current data from the brokerage during API calls. See the "Data freshness" column on the "Positions & recent orders" tab at https://support.snaptrade.com/brokerages.

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
      "is_degraded": 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
    "name": "Connection-1",
32
    "type": "trade",
33
    "disabled": false,
34
    "disabled_date": "2022-01-21T20:11:19.217Z",
35
    "meta": {
36
      "identifier": 123456
37
    },
38
    "updated_date": "2024-08-20T21:56:20.057Z",
39
    "is_eligible_for_payout": true,
40
    "data_freshness_mode": "realtime"
41
  }
42
]