Changelogs

Dual-Ccy Product

Get User Assets

GET /dual/api/v1/assets

ratelimit: 10 requests/second.

Query parameters

None

curl "https://mapi.matrixport.com/dual/api/v1/assets?timestamp=1628647842000&signature=5ef34f9cf22328390bb9282131c40dfbe9dca86c2b30c9c4d9acab1130fdfc14"

Response

{
    "code": 0, 
    "message": "OK", 
    "data": [
        {
            "currency": "BTC", 
            "available_balance": "9860.38245547", 
            "balance": "9860.38245547", 
            "frozen_balance": "0"
        }
    ]
}

Response

Get Dual products

GET /dual/api/v1/products

ratelimit: 10 requests/second.

Query parameters

curl "https://mapi.matrixport.com/dual/api/v1/products?category=1&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"

Response

{
    "code": 0, 
    "message": "OK", 
    "data": [
        {
            "id": 6488234, 
            "name": "Dual Currency-BTC-2265", 
            "category": "1", 
            "instrument": "BTC-30JUL21-34000-C", 
            "striking_price": "34000", 
            "cp_type": 0, 
            "min_qty": "0.01", 
            "rule": "<p>Rule description</p>", 
            "profit_rule": "<p><span style=\"font-size: 14px;\">Income rule</span></p>", 
            "finish_time": 1627632000000, 
            "risk": "Risk Warning", 
            "status": 1, 
            "description": "", 
            "real_profit": "0.0108", 
            "year_profit": "0.5631", 
            "kyc_limit": 0, 
            "diff_day": 7, 
            "step": "0.01", 
            "type": 0, 
            "quantity": "222.6"
        }
    ]
}

Response

Place Order

POST /dual/api/v1/place/order

ratelimit: 5 requests/second.

Query parameters

curl -H "Content-Type:application/json" -X POST --data '{"pid":6550241,,,,"biz_order_id":"test","quantity":"0.1","timestamp":1628909085000,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}' https://mapi.matrixport.com/dual/api/v1/place/order

Response

{
    "code": 0, 
    "message": "OK", 
    "data": {
        "quantity": "0.1", 
        "order_id": "615286996410847240", 
        "biz_order_id": "test",
        "create_time": 1626862329785, 
        "complete_time": 1626941289677, 
        "settle_time": 1626941289178, 
        "status": 0, 
        "order_type": 0, 
        "base_currency": "BTC", 
        "settle_currency": "USDC", 
        "striking_price": "32000", 
        "settle_amount": "160832", 
        "pid": 6475805, 
        "category": 1, 
        "instrument": "BTC-22JUL21-32000-C", 
        "name": "Dual Currency-BTC-3346", 
        "finish_time": 1626940800000, 
        "real_profit": "0.0052000000000000", 
        "year_profit": "1.89800000", 
        "classify": 0,
        "settle_price": ""
    }
}

Response

Get Orders

GET /dual/api/v1/orders

ratelimit: 10 requests/second.

Query parameters

curl "https://mapi.matrixport.com/dual/api/v1/orders?order_id=618203915149492407&timestamp=1628648187000&signature=905af0948e168cb4489841a44e2f85d5bdaea69cca5ddfdadc011a376c31a613"

Response

{
    "code": 0, 
    "message": "OK", 
    "data": [
        {
            "quantity": "5.0000000000000000", 
            "order_id": "615286996410847240", 
            "biz_order_id": "615286996410847240",
            "create_time": 1626862329785, 
            "complete_time": 1626941289677, 
            "settle_time": 1626941289178, 
            "status": 3, 
            "order_type": 0, 
            "base_currency": "BTC", 
            "settle_currency": "USDC", 
            "striking_price": "32000", 
            "settle_amount": "160832", 
            "pid": 6475805, 
            "category": 1, 
            "instrument": "BTC-22JUL21-32000-C", 
            "name": "Dual Currency-BTC-3346", 
            "finish_time": 1626940800000, 
            "real_profit": "0.0052000000000000", 
            "year_profit": "1.89800000", 
            "classify": 0,
            "settle_price": "33011"
        }
    ]
}

Response

Constant definitions

Dual Category

Dual Classify

Order status

Product Status

Errors

Error Handling

A clarification of Matrixport APIs:

When calling the APIs of Matrixport,the caller will get one of the following four types of results:

1. A response indicating the request was successful
2. A response indicating the request had been rejected
3. A response indicating failed to get the processing result of the request
4. Failed to receive a response (should be handled similarly to type 3, see below)

A result of type 3. happens when the frontend web servers of matrixport.com failed to receive a response from the matching engine in time (due to a network issue or a timeout). The response can be in the form of

1. A HTTP response with status "504 - Gateway Timeout", when the failure was at the gateway layer.
2. A HTTP response with status "200 - OK", but the JSON error code != 0
3. Other forms of network errors if the failure was even before the gateway of matrixport.

When a result of type 3 happens, it is unknown to the caller whether the sent request has been received/processed/rejected by the matching engine. Therefore, the caller has to make another call to check the state of the order or the account to find out.

Error code list

Matrixport API error codes: