API Access Permissions
How to create an API key
You can create an API key on the API Access page of your BtcTurk Global account:
- Log in to your account at https://global.btcturk.com.
- Once you are logged in, open the API Access page: https://global.btcturk.com/account/api-access.
If you open the API Access link before you log in, you land on the home page after logging in, not on API Access. Open the link again once you are logged in.
Permission groups
The BtcTurk Global API authenticates private requests with HMAC headers (X-PCK / X-Stamp / X-Signature, optionally X-Nonce). See Authentication V1 for the signing details.
If your API keys are accidentally shared, delete them immediately and create new ones.
BtcTurk Global API groups private endpoints into permission accessibility groups. A request is matched to a group by its path, and your API key must be authorized for that group:
| Group | Endpoints |
|---|---|
| Total Funds | GET /api/v1/users/balances |
| Trade | POST /api/v1/orderDELETE /api/v1/orderDELETE /api/v1/order/{id}GET /api/v1/openOrdersGET /api/v1/allOrdersGET /api/v1/order/{orderId} |
| Account | GET /api/v1/users/transactions/tradeGET /api/v1/users/transactions/cryptoGET /api/v1/volumes |
| WebSocket | Logging in on the WebSocket feed (message type 114) to receive your own order, trade and balance events |
| Crypto Asset Withdrawal | GET /api/v1/crypto-deposit-addressesGET /api/v1/crypto-deposit-addresses/{id}GET /api/v1/crypto-withdrawal-addressesGET /api/v1/crypto-withdrawal-addresses/{id}POST /api/v1/crypto-withdrawalsGET /api/v1/crypto-withdrawalsGET /api/v1/crypto-withdrawals/{id} |
Reading your deposit addresses requires the Crypto Asset Withdrawal group.
All other endpoints (V2 market data, /api/v1/currencies, /api/v1/pairs, /api/v2/currency-channels, /api/v2/crypto-channels, /api/v2/server/exchangeinfo, /api/v2/ticker, /api/v2/orderbook, /api/v2/trades) are public and require no authentication.