API docs by Redocly

Centralized Auton eXchange (CAX) API (0.1.0)

Download OpenAPI specification:Download

Account

Create API Key

Authorizations:
API-Sig
Request Body schema: application/json
nonce
string (Nonce)

Responses

Request samples

Content type
application/json
{
  • "nonce": "string"
}

Response samples

Content type
application/json
{
  • "account": "string",
  • "apikey": "string"
}

Get balances

Authorizations:
API-Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get balance for symbol

Authorizations:
API-Key
path Parameters
symbol
required
string

Responses

Response samples

Content type
application/json
{
  • "available": "string",
  • "balance": "string",
  • "symbol": "string"
}

Get deposits

Limit of 500 deposits per request, use parameters to customize.

Authorizations:
API-Key
query Parameters
end
string
start
string
symbol
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get deposit info

Authorizations:
API-Key
path Parameters
txid
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get refunds

Limit of 500 refunds per request, use parameters to customize.

Authorizations:
API-Key
query Parameters
end
string
start
string
symbol
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get refund info

Authorizations:
API-Key
path Parameters
txid
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get withdraws

Limit of 500 withdraws per request, use parameters to customize.

Authorizations:
API-Key
query Parameters
status
string
end
string
start
string
symbol
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Request withdraw

Authorizations:
API-Key
Request Body schema: application/json
amount
string (Amount)
symbol
string (Symbol)

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "symbol": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get withdraw info

Authorizations:
API-Key
path Parameters
txid
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Exchange

Get order books

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get order book info

path Parameters
pair
required
string

Responses

Response samples

Content type
application/json
{
  • "base": "string",
  • "min_amount": "string",
  • "pair": "string",
  • "quote": "string",
  • "tick_size": "string"
}

Get order book depth

path Parameters
pair
required
string

Responses

Response samples

Content type
application/json
{
  • "asks": [
    ],
  • "bids": [
    ],
  • "timestamp": "string"
}

Get order book quote

path Parameters
pair
required
string

Responses

Response samples

Content type
application/json
{
  • "ask_amount": "string",
  • "ask_price": "string",
  • "bid_amount": "string",
  • "bid_price": "string",
  • "timestamp": "string"
}

Get trade history

Returns last 24 hours of trade data. Specify date for daily historical data.

path Parameters
pair
required
string
query Parameters
date
string

YYYY-MM-DD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get exchange status

This endpoint always returns true.

Responses

Response samples

Content type
application/json
true

Get symbols

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get symbol info

path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "address": null,
  • "decimals": null,
  • "name": "string",
  • "type": "string"
}

Trading

Get orders

Limit of 500 orders per request, use parameters to customize.

Authorizations:
API-Key
query Parameters
end
string
start
string
status
string
pair
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Submit a limit order

Authorizations:
API-Key
Request Body schema: application/json
amount
string (Amount)
pair
string (Pair)
price
string (Price)
side
string
Enum: "bid" "ask"

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "pair": "string",
  • "price": "string",
  • "side": "bid"
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "order_id": 0,
  • "pair": "string",
  • "price": "string",
  • "remain": "string",
  • "side": "bid",
  • "status": "pending",
  • "timestamp": "string",
  • "type": "limit"
}

Cancel an order

Authorizations:
API-Key
path Parameters
order_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "amount": "string",
  • "order_id": 0,
  • "pair": "string",
  • "price": "string",
  • "remain": "string",
  • "side": "bid",
  • "status": "pending",
  • "timestamp": "string",
  • "type": "limit"
}

Get order info

Authorizations:
API-Key
path Parameters
order_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "amount": "string",
  • "order_id": 0,
  • "pair": "string",
  • "price": "string",
  • "remain": "string",
  • "side": "bid",
  • "status": "pending",
  • "timestamp": "string",
  • "type": "limit"
}

Get trades

Limit of 500 trades per request, use parameters to customize.

Authorizations:
API-Key
query Parameters
end
string
start
string
pair
string
order_id
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get trade info

Authorizations:
API-Key
path Parameters
trade_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "amount": "string",
  • "order_id": 0,
  • "pair": "string",
  • "price": "string",
  • "side": "string",
  • "timestamp": "string",
  • "trade_id": 0
}