This is the Trading API that enables our Market Makers.
Some endpoints are public and do not require any form for authentication and authorization, and some are private which means that they require authentication and authorization. The private endpoints require an access key (See section about authentication for more information about access keys). The user can define the security levels of their access key(s)
Error | Error description |
---|---|
ApiKeyNotFound | The request contains an access key that was not found in our systems |
Expired Signature | The request contains an expired hmac encrypted secretKey. Make sure the timestamp was not made in the past and that the validity is sufficient |
Invalid Signature | The hmac encrypted secretKey did not match with our hmac encryption of APIkey. PS! Timestamp and validity has to be strings |
SecurityLevelTooLow | Try changing the security level of your access key, to the required security level. |
Provides current time as epoch. Recommended to use for the timestamp required for HMAC encryption of your secretKey
Direction is either end
or start
direction | string |
count | integer <int32> |
[- {
- "id": "string",
- "amount": "string",
- "currency": "string",
- "type": "string",
- "date": "string",
- "details": {
- "match_id": "string",
- "deposit_id": "string",
- "deposit_address": "string",
- "deposit_txid": "string",
- "withdraw_id": "string",
- "withdraw_address": "string",
- "withdraw_txid": "string"
}
}
]
Direction is either end
or start
.
year
> 2017
year required | string |
direction | string |
[- {
- "id": "string",
- "amount": "string",
- "currency": "string",
- "type": "string",
- "date": "string",
- "details": {
- "match_id": "string",
- "deposit_id": "string",
- "deposit_address": "string",
- "deposit_txid": "string",
- "withdraw_id": "string",
- "withdraw_address": "string",
- "withdraw_txid": "string"
}
}
]
Direction is either end
or start
.
12 >= month
>= 1
year
> 2017
month required | string |
year required | string |
direction | string |
[- {
- "id": "string",
- "amount": "string",
- "currency": "string",
- "type": "string",
- "date": "string",
- "details": {
- "match_id": "string",
- "deposit_id": "string",
- "deposit_address": "string",
- "deposit_txid": "string",
- "withdraw_id": "string",
- "withdraw_address": "string",
- "withdraw_txid": "string"
}
}
]
type | string |
count | integer <int32> |
[- {
- "id": "string",
- "market": "string",
- "price": "string",
- "price_currency": "string",
- "amount": "string",
- "amount_currency": "string",
- "cost": "string",
- "cost_currency": "string",
- "side": "string",
- "isMaker": true,
- "date": "string"
}
]
market required | string |
type | string |
count | integer <int32> |
[- {
- "id": "string",
- "market": "string",
- "price": "string",
- "price_currency": "string",
- "amount": "string",
- "amount_currency": "string",
- "cost": "string",
- "cost_currency": "string",
- "side": "string",
- "isMaker": true,
- "date": "string"
}
]
{- "count": 0,
- "pending": [
- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "amount": "string",
- "state": "string",
- "address": "string",
- "completed": "2019-08-24T14:15:22Z"
}
]
}
{- "count": 0,
- "pending": [
- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "amount": "string",
- "state": "string",
- "address": "string",
- "completed": "2019-08-24T14:15:22Z"
}
]
}
{- "count": 0,
- "pending": [
- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "amount": "string",
- "state": "string",
- "address": "string",
- "completed": "2019-08-24T14:15:22Z"
}
]
}
{- "count": 0,
- "pending": [
- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "amount": "string",
- "state": "string",
- "address": "string",
- "completed": "2019-08-24T14:15:22Z"
}
]
}
{- "count": 0,
- "pending": [
- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "amount": "string",
- "state": "string",
- "address": "string",
- "completed": "2019-08-24T14:15:22Z"
}
]
}
{- "count": 0,
- "pending": [
- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "amount": "string",
- "state": "string",
- "address": "string",
- "completed": "2019-08-24T14:15:22Z"
}
]
}
count | integer <int32> |
before | integer <int32> |
{- "count": 0,
- "transactions": [
- {
- "id": 0,
- "amount": "string",
- "currency": "string",
- "deposited_at": "string",
- "transaction_hash": "string",
- "status": "string",
- "confirmations": 0,
- "required": 0
}
]
}
[- {
- "id": 0,
- "market": "string",
- "type": "string",
- "price": "string",
- "amount": "string",
- "remaining": "string",
- "matched": "string",
- "cancelled": "string",
- "created_at": "string"
}
]
Only "bid" and "ask" is supported as type at this time. Markets can be retrieved by the market operations. If you have trouble using HMAC authentication with this endpoint, see section 'POST requests and HMAC authentication'
market required | string |
type required | string |
price required | string |
amount required | string |
{- "market": "string",
- "type": "string",
- "price": "string",
- "amount": "string"
}
{- "id": 0
}
market required | string |
count | integer <int32> |
[- {
- "id": 0,
- "market": "string",
- "type": "string",
- "price": "string",
- "amount": "string",
- "remaining": "string",
- "matched": "string",
- "cancelled": "string",
- "created_at": "string"
}
]
market required | string |
count | integer <int32> |
[- {
- "id": 0,
- "market": "string",
- "type": "string",
- "price": "string",
- "amount": "string",
- "remaining": "string",
- "matched": "string",
- "cancelled": "string",
- "created_at": "string"
}
]
count | integer <int32> |
[- {
- "id": 0,
- "market": "string",
- "type": "string",
- "price": "string",
- "amount": "string",
- "remaining": "string",
- "matched": "string",
- "cancelled": "string",
- "created_at": "string"
}
]
orderID required | integer <int64> |
[- {
- "id": 0,
- "market": "string",
- "type": "string",
- "price": "string",
- "amount": "string",
- "remaining": "string",
- "matched": "string",
- "cancelled": "string",
- "created_at": "string"
}
]
orderID required | integer <int64> |
market required | string |
{- "matched": "string"
}