logo
Reference Data

Get metadata related to Snaptrade partner

get
https://api.snaptrade.com/api/v1/snapTrade/partners

Returns useful data related to the specified ClientID, including allowed brokerages and data access.

Execute an API Request

No request parameters.
Authorization
Request
Installation
$
npm install snaptrade-typescript-sdk
1
Loading...

Response fields

object

SnapTrade Partner metadata

redirect_uristring

URI to redirect user back to after user is done adding brokerage connections

allowed_brokeragesarray of objects

Brokerages that can be accessed by partners

namestring

Name of Snaptrade Partner

slugstring

Slug of Snaptrade Partner

logo_urlstring

URL to partner's logo

pin_requiredboolean

Shows if pin is required by users to access connection page

can_access_tradesboolean

Shows if users of Snaptrade partners can access trade endpoints

can_access_holdingsboolean

Shows if Snaptrade partners can get user holdings data

can_access_account_historyboolean

Shows if Snaptrade partners can get users account history data

can_access_reference_databoolean

Shows if Snaptrade partners can get users holdings data

can_access_portfolio_managementboolean

Shows if users Snaptrade partners can access portfolio group management features

can_access_ordersboolean

Shows if Snaptrade partners can get users account order history

1
{
2
"redirect_uri": "https://example.com/oauth/snaptrade",
3
"allowed_brokerages": [
4
{
5
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
6
"name": "Questrade",
7
"display_name": "Questrade",
8
"description": "Questrade is an online brokerage firm and wealth management firm based in Canada. It is Canada's largest discount broker.",
9
"aws_s3_logo_url": "https://www.snaptrade.com/questrade.logo",
10
"aws_s3_square_logo_url": "https://www.snaptrade.com/questrade.logo",
11
"open_url": "https://www.brokerage.com",
12
"slug": "QUESTRADE",
13
"url": "https://www.questrade.com/",
14
"enabled": true,
15
"maintenance_mode": true,
16
"allows_fractional_units": true,
17
"allows_trading": true,
18
"has_reporting": true,
19
"is_real_time_connection": true,
20
"allows_trading_through_snaptrade_api": true,
21
"is_scraping_integration": true,
22
"default_currency": "2bcd7cc3-e922-4976-bce1-9858296801c3",
23
"brokerage_type": {
24
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
25
"name": "Traditional Brokerage"
26
},
27
"exchanges": [
28
"2bcd7cc3-e922-4976-bce1-9858296801c3",
29
"4bcd8cc3-c122-4974-dc21-1858296801f4"
30
]
31
}
32
],
33
"name": "Wealthy Chimpmunk",
34
"slug": "WEALTHYCHIPMUNK",
35
"logo_url": "https://example.com/logo.png",
36
"pin_required": false,
37
"can_access_trades": true,
38
"can_access_holdings": true,
39
"can_access_account_history": true,
40
"can_access_reference_data": true,
41
"can_access_portfolio_management": true,
42
"can_access_orders": true
43
}