https://cxch.cx/api
api_key
parameter) might be required for each endpoint if the service is under abnormal load. Contact support@cxch.cx or create a support ticket to request an API key.rate_mode
- Rate mode - flat
or dynamic
(Optional; Default: dynamic
) FROMCURRENCY_TOCURRENCY
; for example, the rate for Bitcoin/Litecoin will have the following key: BTC_LTC
rate
- cxchange rate with fee (includes a service fee of the chosen rate_mode
)svc_fee
- Service fee for selected rate_mode
rate_mode
- Selected rate_mode
reserve
- Total reserve of the currency to receive (the amount this cxchange service is capable of sending)volume
- 24h volume (inbound and outbound)status
- Node status - online
or offline
aggregated_balance
- Aggregated pool balance (for BTC
only)mixed_balance
- Mixed pool balance (for BTC
only)from_currency
- Currency to sendto_currency
- Currency to receiveto_address
- Address for to_currency
refund_address
- Refund address for from_currency
, needed when an cxchange fails (Optional; possible to provide during REFUND_REQUEST state)rate_mode
- Rate mode - flat
or dynamic
(Optional; Default: dynamic
) ref
- Referrer ID (Optional)fee_option
- Network fee option - s
for slow, m
for medium, f
for quick (Optional; Default: f
; Used only when to_currency
is BTC
,ETH
,DAI
,USDC
or USDT
) aggregation
- BTC aggregation pool - yes
for aggregated (receive and send), no
for mixed (receive and send), any
for any (send only) (Optional; Default: yes
when from_currency
is BTC, any
when to_currency
is BTC)orderid
- cxchange order ID for /api/order
orderid
- cxchange order ID created by /api/create
created
- Order creation timestampstate
- Current state of the cxchange, possible values: CREATED, CANCELLED, AWAITING_INPUT, CONFIRMING_INPUT, cxchANGING, FUNDED, BRIDGING, CONFIRMING_SEND, COMPLETE, REFUND_REQUEST, REFUND_PENDING, CONFIRMING_REFUND, REFUNDEDfrom_currency
- Currency to sendfrom_addr
- Address for from_currency
(this address should be deposited in order to initiate the cxchange)to_currency
- Currency to receiveto_address
- Address for to_currency
rate_mode
- Rate mode (flat
or dynamic
) rate
- Current ratesvc_fee
- Service fee (included in the calculated amount of to_currency
)network_fee
- Network fee (included in the calculated amount of to_currency
)from_amount_received
- Amount of from_currency
received (null
when no amount received yet)to_amount
- Amount of to_currency
to be sent (null
when no amount received yet)wallet_pool
- Selected wallet pool (currently only supported when to_currency
is BTC
) - aggregated
for aggregated, mixed
for mixed, any
for all availabletransaction_id_received
- Transaction ID for from_currency
received (null
when no amount received yet)transaction_id_sent
- Transaction ID for to_currency
sent (null
when cxchange not finished yet)refund_private_key
- Private key in case an ETH token is refunded in the REFUNDED
state (when from_currency
is one of USDC
, DAI
, USDT
) min_input
- Minimum amount of from_currency
to depositmax_input
- Maximum amount of from_currency
to depositstate_error
- Current error state, if any (only present on error)refund_available
- Refund user action availability for the current state of the order (Boolean)orderid
- cxchange order IDorderid
- cxchange order ID created by /api/create
1P59vP5TNXAFRnQJvZSkwhYXejYW3tcxch
orderid
- cxchange order ID created by /api/create
result
- true
for a successful request, false
for a failed request (Boolean)error
- Error message in case the request failedREFUND_REQUEST
)
orderid
- cxchange order ID created by /api/create
refund_address
- Address for from_currency
to send a refundresult
- true
for a successful request, false
for a failed request (Boolean)error
- Error message in case the request failedstate_error
is TO_ADDRESS_INVALID
orderid
- cxchange order ID created by /api/create
to_address
- Address for to_currency
result
- true
for a successful request, false
for a failed request (Boolean)error
- Error message in case the request failedCOMPLETE
)
orderid
- cxchange order ID created by /api/create
result
- true
for a successful request, false
for a failed request (Boolean)error
- Error message in case the request failedorderid
- cxchange order ID created by /api/create
supportmessage
- Messageresult
- true
for a successful request, false
for a failed request (Boolean)error
- Error message in case the request failedorderid
- cxchange order ID created by /api/create
timestamp
, sender
, message
and read_by_support
(if the message's sender
is USER
) for each element