Sign in
Reference Data

Get brokerages

Returns a list of all defined Brokerage objects.

get/brokerages

Response

A list of all defined Brokerage objects.

idstring uuid

Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade.

slugstring

A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.

namestring

Full name of the brokerage.

display_namestring

A display-friendly name of the brokerage.

descriptionstring

A brief description of the brokerage.

aws_s3_logo_urlstring url

URL to the brokerage's logo.

aws_s3_square_logo_urlstring url nullable

URL to the brokerage's logo in square format.

urlstring url

URL to the brokerage's website.

enabledboolean

Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections.

maintenance_modeboolean

Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections.

is_degradedboolean

Whether the brokerage is currently degraded. A degraded brokerage may have reduced functionality or be experiencing technical issues.

allows_tradingboolean nullable

Whether the brokerage allows trading through SnapTrade.

allows_fractional_unitsboolean nullable

This field is deprecated. Please contact us if you have a valid use case for it.

has_reportingboolean nullable

This field is deprecated. Please contact us if you have a valid use case for it.

is_real_time_connectionboolean

This field is deprecated. Please contact us if you have a valid use case for it.

open_urlstring url nullable

This field is deprecated.

Example response

[
  {
    "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"
    ]
  }
]

Changes