Access Token Request
Request
Response
Non-empty if the request failed
Non-empty if the request failed
Available to: Anyone with valid API credentials (no access token required)
Environments: Demo, Live
Rate Limit: 5 requests per hour, 15-second back-off, counts failed requests only
Exchange your credentials for an access token, then send that token with the Bearer scheme on subsequent requests. Provide your name and password, your application identifiers (appId, appVersion, deviceId), and your API Key (cid and sec). On success, the response includes an accessToken and its expirationTime, plus an mdAccessToken for market data requests.
A successful request starts a tracked session. Mind the token lifetime and session limits:
expirationTime. Extend it by calling renewAccessToken about 15 minutes before it expires, rather than requesting a new token.See Authentication & Access for the full walkthrough and session guidance.
Common Failure Scenarios
name/password or API Key (cid/sec) is incorrect.p-ticket and p-time, and you can retry after p-time seconds. When p-captcha is true, retry from a third-party application is blocked for about an hour.Error Messages