---
title: "Get Client Info"
method: GET
path: "/snapTrade/partners"
tags: ["Reference Data"]
---

# Get Client Info

`GET /snapTrade/partners`

Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.

## Response `200`

OK

- PartnerData — Configurations for your SnapTrade Client ID, including allowed brokerages and data access.
  - `slug` string — A short, unique identifier for your company or product.
  - `name` string — Your company or product name.
  - `logo_url` string, nullable — URL to your company or product logo. Returns null if no logo has been configured (always the case for personal access clients).
  - `allowed_brokerages` Brokerage[] — Brokerages that can be accessed by your Client ID.
    - `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.
  - `can_access_trades` boolean — Whether trading is enabled for your SnapTrade Client ID.
  - `can_access_holdings` boolean — Whether holdings data is enabled for your SnapTrade Client ID.
  - `can_access_account_history` boolean — Whether account historical transactions is enabled for your SnapTrade Client ID.
  - `can_access_reference_data` boolean — Whether reference data is enabled for your SnapTrade Client ID.
  - `can_access_portfolio_management` boolean — Whether portfolio management is enabled for your SnapTrade Client ID.
  - `can_access_orders` boolean — Whether recent order history is enabled for your SnapTrade Client ID.
  - `redirect_uri` string, nullable — URI to redirect user back to after user is done adding brokerage connections. Returns null if no redirect URI has been configured (always the case for personal access clients).
  - `pin_required` boolean — Shows if pin is required by users to access connection page. This field has been deprecated.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `500` — 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/revisions/78cac0377d17/schema)