Get orders list

get https://api.cryptomus.com/v2/user-api/convert/order-list Copy

Request

Query parameters

Name	Parameter type	Default value	Definition
cursor	string	null	Cursor
type	string	null	Type enumAvailable options:• market• limit
status	string	null	Status enumAvailable options:• active• completed• partially_completed• cancelled• expired• failed

: Parameter type
string
Default value
null
Definition
Cursor
: Parameter type
string
Default value
null
Definition
Type enumAvailable options:- market- limit
: Parameter type
string
Default value
null
Definition
Status enumAvailable options:- active- completed- partially_completed- cancelled- expired- failed

Request example

curl https://api.cryptomus.com/v2/user-api/convert/order-list?cursor=eyJpdiI6IlRDMzlwWnI3MkZsTHRWdWdPUTZmenc9PSIsInZhbHVlIjoicWxiQTIvNzZycCtZKzFQRzlXQUFGcmdWLzRLMXhmUk1hZmZkSTBlNW9qSUkzVWplakdqUjlQNjNRdTM1TEZ5cTRVOW1acGs5VnRuMHdJVVZJN2QrcVE1aC8zZnFNWmRtZmpkaDloNFNkTTQ0YTF0N2tyNXh2c3VKNXkxSkRsRVUiLCJtYWMiOiJmNDU1ZTJiNjJlZjRmYWY3MDhmMTE3ZDVkNWE4OTUyNjg1MDM4OWUyZmRiM2I0YWZiMmUwNDRkMDRjMTUzNzJkIiwidGFnIjoiIn0= \
    -X GET \
    -H 'userId: 8b03432e-385b-4670-8d06-064591096795' \
    -H 'sign: fe99035f86fa436181717b302b95bacff1' \
    -H 'Content-Type: application/json' \
    -d '{
      "type": "limit",
      "status": "cancelled"
    }'

Copy

Response

Response parameters

Name	Parameter type	Definition
items		Array of collection items
order_id	string	Id of convert
uuid	string	UUID of convert Order
convert_amount_from	string\|null	Convert amount from
convert_amount_to	string\|null	Convert amount to
executed_amount_from	string\|null	Executed amount from
executed_amount_to	string\|null	Executed amount to
convert_currency_from	string\|null	Convert currency from
convert_currency_to	string\|null	Convert currency to
type	string	Type enumAvailable options:• market• limit
status	string	Status enumAvailable options:• active• completed• partially_completed• cancelled• expired• failed
created_at	string	Date time create
current_rate	string\|null	Current rate
market_rate	string\|null	Market rate
limit	string\|null	Limit value (only if type limit)
expires_at	string	Limit expires date time
completed_at	string	Date time when order completed (only if order completed)
paginate		Paginate data
count	integer	Count of item elements in response
hasPages	boolean	Isset pages
nextCursor	string\|null	Next cursor
previousCursor	string\|null	Previous cursor
perPage	integer	Count of elements in page

: Definition
Array of collection items
: Parameter type
string
Definition
Id of convert
: Parameter type
string
Definition
UUID of convert Order
: Parameter type
string|null
Definition
Convert amount from
: Parameter type
string|null
Definition
Convert amount to
: Parameter type
string|null
Definition
Executed amount from
: Parameter type
string|null
Definition
Executed amount to
: Parameter type
string|null
Definition
Convert currency from
: Parameter type
string|null
Definition
Convert currency to
: Parameter type
string
Definition
Type enumAvailable options:- market- limit
: Parameter type
string
Definition
Status enumAvailable options:- active- completed- partially_completed- cancelled- expired- failed
: Parameter type
string
Definition
Date time create
: Parameter type
string|null
Definition
Current rate
: Parameter type
string|null
Definition
Market rate
: Parameter type
string|null
Definition
Limit value (only if type limit)
: Parameter type
string
Definition
Limit expires date time
: Parameter type
string
Definition
Date time when order completed (only if order completed)
: Definition
Paginate data
: Parameter type
integer
Definition
Count of item elements in response
: Parameter type
boolean
Definition
Isset pages
: Parameter type
string|null
Definition
Next cursor
: Parameter type
string|null
Definition
Previous cursor
: Parameter type
integer
Definition
Count of elements in page

Response example


1{
2  "state": 0,
3  "result": {
4    "items": [
5      {
6        "order_id": "2d9bf426-98ef-448b-84c2-03cc1ec78feb",
7        "uuid": "740a39d1-2edd-4b4d-bf49-826caf324312",
8        "convert_amount_from": "0.03700249",
9        "convert_amount_to": "2476.39230892",
10        "executed_amount_from": "0.03700249",
11        "executed_amount_to": "2476.39230892",
12        "convert_currency_from": "BTC",
13        "convert_currency_to": "USDT",
14        "type": "market",
15        "status": "completed",
16        "created_at": "2024-03-25 , 11:24:55",
17        "current_rate": "66925.01798999",
18        "market_rate": "66925.01798999",
19        "completed_at": "2024-03-25 , 11:25:03"
20      }
21    ],
22    "paginate": {
23      "count": 15,
24      "hasPages": true,
25      "nextCursor": "eyJpdiI6ImRtQnpjUUorSkNPNXRtcGNzdVB6Mnc9PSIsInZhbHVlIjoiajArWmVOTTFEUzdJK2xUZmtLWm9Td2NEcTBmZmRQRUNkN203L0JZTUhicDVxYjBjQXpsZ0NDUkVBQjc3cFBXemZWbENQbmRVNEZPVm5FeCthM2tsV0VHODZ2aVp3MEg3SDc1VnRqeTNXbU8zTERORVp2L1JlQ0hHRWtjdkE2bTIiLCJtYWMiOiI1MjNjNjU0MzJkYmNmZWY1ZjQ4Zjc5ODMxOTExZmEzYWQzMDM3YTQxOTYyMmMyMWZlN2ZjYzJlZWE1MDAwMTY2IiwidGFnIjoiIn0=",
26      "previousCursor": "eyJpdiI6IlRDMzlwWnI3MkZsTHRWdWdPUTZmenc9PSIsInZhbHVlIjoicWxiQTIvNzZycCtZKzFQRzlXQUFGcmdWLzRLMXhmUk1hZmZkSTBlNW9qSUkzVWplakdqUjlQNjNRdTM1TEZ5cTRVOW1acGs5VnRuMHdJVVZJN2QrcVE1aC8zZnFNWmRtZmpkaDloNFNkTTQ0YTF0N2tyNXh2c3VKNXkxSkRsRVUiLCJtYWMiOiJmNDU1ZTJiNjJlZjRmYWY3MDhmMTE3ZDVkNWE4OTUyNjg1MDM4OWUyZmRiM2I0YWZiMmUwNDRkMDRjMTUzNzJkIiwidGFnIjoiIn0=",
27      "perPage": 15
28    }
29  }
30}
31

Copy