logo
Connections

Get brokerage authorization details

get
https://api.snaptrade.com/api/v1/authorizations/{authorizationId}

Returns a single brokerage authorization object for the specified ID.

Execute an API Request

Path
authorizationIdstring (format: uuid)required

The ID of a brokerage authorization object.

Query
userIdstringrequired

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.

userSecretstringrequired

SnapTrade User Secret (generated when registering user)

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

Response fields

object
idstring (format: uuid)
created_datestring

Time

updated_datestring

Time

brokerageobject
namestring

Connection Name

typestring
disabledboolean
disabled_datestring or null

Disabled date

metaobject

Additional data about brokerage authorization

1
{
2
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
3
"created_date": "2022-01-21T20:11:19.217Z",
4
"updated_date": "2022-01-21T20:11:19.217Z",
5
"brokerage": {
6
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
7
"name": "Questrade",
8
"display_name": "Questrade",
9
"description": "Questrade is an online brokerage firm and wealth management firm based in Canada. It is Canada's largest discount broker.",
10
"aws_s3_logo_url": "https://www.snaptrade.com/questrade.logo",
11
"aws_s3_square_logo_url": "https://www.snaptrade.com/questrade.logo",
12
"open_url": "https://www.brokerage.com",
13
"slug": "QUESTRADE",
14
"url": "https://www.questrade.com/",
15
"enabled": true,
16
"maintenance_mode": true,
17
"allows_fractional_units": true,
18
"allows_trading": true,
19
"has_reporting": true,
20
"is_real_time_connection": true,
21
"allows_trading_through_snaptrade_api": true,
22
"is_scraping_integration": true,
23
"default_currency": "2bcd7cc3-e922-4976-bce1-9858296801c3",
24
"brokerage_type": {
25
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
26
"name": "Traditional Brokerage"
27
},
28
"exchanges": [
29
"2bcd7cc3-e922-4976-bce1-9858296801c3",
30
"4bcd8cc3-c122-4974-dc21-1858296801f4"
31
]
32
},
33
"name": "Connection-1",
34
"type": "trade",
35
"disabled": false,
36
"disabled_date": "2022-01-21T20:11:19.217Z",
37
"meta": {
38
"identifier": 123456
39
}
40
}