--- title: "Get connection detail" method: GET path: "/authorizations/{authorizationId}" tags: ["Connections"] --- # Get connection detail `GET /authorizations/{authorizationId}` Returns a single connection for the specified ID. ## Path parameters - `authorizationId` string, uuid, required — Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade. ## Query parameters - `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](/reference/Authentication/Authentication_resetSnapTradeUserSecret). ## Response `200` OK - BrokerageAuthorization — 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. - `id` string, uuid — Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade. - `created_date` string, date-time — Timestamp of when the connection was established in SnapTrade. - `brokerage` Brokerage — Describes a brokerage that SnapTrade supports. - `id` string, 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, url — URL to the brokerage's logo. - `aws_s3_square_logo_url` string, url, nullable — URL to the brokerage's logo in square format. - `url` string, url, nullable — URL to the brokerage's website. Returns null if the brokerage has no website on record. - `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. - `is_degraded` boolean — Whether the brokerage is currently degraded. A degraded brokerage may have reduced functionality or be experiencing technical issues. - `allows_trading` boolean, nullable — Whether the brokerage allows trading through SnapTrade. - `allows_fractional_units` boolean, nullable — This field is deprecated. Please contact us if you have a valid use case for it. - `has_reporting` boolean, nullable — This field is deprecated. Please contact us if you have a valid use case for it. - `is_real_time_connection` boolean — This field is deprecated. Please contact us if you have a valid use case for it. - `brokerage_type` BrokerageType — Type of brokerage. Currently supports traditional brokerages and crypto exchanges. - `id` string, uuid - `name` string - `exchanges` unknown[] — This field is deprecated. Please contact us if you have a valid use case for it. - unknown - `open_url` string, url, nullable — 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](/docs/fix-broken-connections) on how to fix a disabled connection. - `disabled_date` string, date-time, nullable — Timestamp of when the connection was disabled in SnapTrade. - `meta` object — 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, 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_payout` boolean — 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_mode` string — 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. ## Other responses - `default` — Unexpected error. --- [API](https://skmtc.net/passiv/apis/snaptrade.md) · [All operations](https://skmtc.net/passiv/apis/snaptrade/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/passiv/snaptrade/versions/993e058b557e/schema)