Connections

Get connection detail

Changed on

Returns a single connection for the specified ID.

get/authorizations/{authorizationId}

Request

  • Base URL
    https://api.snaptrade.com
  • URL
    https://api.snaptrade.com/authorizations/{authorizationId}
  • Auth
    API key in header Signature and API key in query parameter clientId and API key in query parameter timestamp

Path parameters

authorizationIdstring uuid required

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

Example:87b24961-b51e-4db8-9226-f198f6518a89

Query parameters

userIdstring 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.

Example:snaptrade-user-123
userSecretstring 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.

Example:adf2aa34-8219-40f7-a6b3-60156985cc61

Response

OK

idstring uuid

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

created_datestring date-time

Timestamp of when the connection was established in SnapTrade.

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 date-time nullable

Timestamp of when the connection was disabled in SnapTrade.

metaobject

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 date-time

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.

Example response

{
  "id": "87b24961-b51e-4db8-9226-f198f6518a89",
  "created_date": "2024-08-20T21:56:19.123935Z",
  "brokerage": {
    "id": "ebf91a5b-0920-4266-9e36-f6cfe8c40946",
    "slug": "ROBINHOOD",
    "name": "Robinhood",
    "display_name": "Robinhood",
    "description": "Robinhood is an American multinational financial services corporation based in Menlo Park, California.",
    "aws_s3_logo_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo.png",
    "aws_s3_square_logo_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo-square.png",
    "url": "https://robinhood.com",
    "enabled": true,
    "maintenance_mode": true,
    "is_degraded": true,
    "allows_trading": true,
    "allows_fractional_units": true,
    "has_reporting": true,
    "is_real_time_connection": true,
    "brokerage_type": {
      "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
      "name": "Traditional Brokerage"
    },
    "exchanges": [
      "2bcd7cc3-e922-4976-bce1-9858296801c3",
      "4bcd8cc3-c122-4974-dc21-1858296801f4"
    ]
  },
  "name": "Connection-1",
  "type": "trade",
  "disabled_date": "2022-01-21T15:11:19.217000-05:00",
  "meta": {
    "identifier": 123456
  },
  "updated_date": "2024-08-20T21:56:20.057224Z",
  "is_eligible_for_payout": true,
  "data_freshness_mode": {
    "institution": "realtime",
    "snaptrade": "delayed"
  }
}

Changes

  • efd73af6c911Revision changes
    • breaking

      the // response's property type changed from string to no type, and format from uuid to no format for status

  • 07c9022b410aRevision changes
    • breaking

      the // response's property type changed from no type to string, and format from no format to uuid for status