Reference Data

Get Client Info

Changed on

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

get/snapTrade/partners

Request

  • Base URL
    https://api.snaptrade.com
  • URL
    https://api.snaptrade.com/snapTrade/partners
  • Auth
    API key in header Signature and API key in query parameter clientId and API key in query parameter timestamp

Response

OK

slugstring

A short, unique identifier for your company or product.

namestring

Your company or product name.

logo_urlstring nullable

URL to your company or product logo. Returns null if no logo has been configured (always the case for personal access clients).

can_access_tradesboolean

Whether trading is enabled for your SnapTrade Client ID.

can_access_holdingsboolean

Whether holdings data is enabled for your SnapTrade Client ID.

can_access_account_historyboolean

Whether account historical transactions is enabled for your SnapTrade Client ID.

can_access_reference_databoolean

Whether reference data is enabled for your SnapTrade Client ID.

can_access_portfolio_managementboolean

Whether portfolio management is enabled for your SnapTrade Client ID.

can_access_ordersboolean

Whether recent order history is enabled for your SnapTrade Client ID.

redirect_uristring 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_requiredboolean

Shows if pin is required by users to access connection page. This field has been deprecated.

Example response

{
  "slug": "WEALTHLY",
  "name": "Wealthly",
  "logo_url": "https://example.com/logo.png",
  "allowed_brokerages": [
    {
      "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"
      ]
    }
  ],
  "can_access_trades": true,
  "can_access_holdings": true,
  "can_access_account_history": true,
  "can_access_reference_data": true,
  "can_access_portfolio_management": true,
  "can_access_orders": true,
  "redirect_uri": "https://example.com/oauth/snaptrade"
}

Changes

  • efd73af6c911Revision changes
    • breaking

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

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type 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

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status