Skip to content

REST reference

Interactive reference generated from OpenAPI 3.1:

specs/openapi/openapi.yaml

Seeded from postman/Polaris-OpenAPI-Order.postman_collection.json and aligned with ptrader-api-gateway controllers.

Draft schemas

Most 200 responses are still open objects. Treat request examples from Postman as illustrative until DTO schemas are filled. Track progress in Gap tracker and OpenAPI gaps.

Groups

Tag Controllers (evidence)
Public GeneralApiController, UserDataApiController.queryUserIp
Market Data MktDataApiController
Spot Trading OrderApiController
User Data Stream UserDataApiController (listenKey)
Account AccountApiController, BalanceApiController, AssetApiController
Wallet WalletApiController
Convert ConvertOpenApiController
Fiat FiatOpenApiController, FiatOpenApiV2Controller
Fiat Migration FiatMigrationApiController
Sub-Account SubAccountController
Transfer TransferApiController
Margin & Fund Collect MarginApiController, FundCollectController
Payment Request PaymentRequestController

Spot order types & TIF (trading)

Evidence: NewOrderApiRequest + auth doc place-order section.

Field Values
type LIMIT, MARKET, LIMIT_MAKER, STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
timeInForce GTC (default), IOC, FOK
side BUY, SELL
newOrderRespType ACK, RESULT, FULL
stpFlag STP enum; default noted as CB in auth doc

OpenAPI

Source of truth file (also mirrored at repo specs/openapi/openapi.yaml):

Polaris Public OpenAPI 0.1.0-draft

Polaris public REST API (api-gateway).

Scope = postman/Polaris-OpenAPI-Order.postman_collection.json. Behavior authority = ptrader-api-gateway. Excluded: merchant-api, create-api-key-tool, admin/BFF.

Servers

Description URL
Dev (Postman openapiHost) https://api-gateway-scb.dev.pcrypto.com
[NEEDS-CONFIRMATION: QA/Prod hosts] https://{host}

Account

GET /openapi/account/v3/crypto-accounts

crypto-accounts v3

Description

Source: Postman Polaris-OpenAPI-Order / Account-Asset / crypto-accounts v3.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
currency query string No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/account

account

Description

Source: Postman Polaris-OpenAPI-Order / Account-Asset / account.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/asset/tradeFee

tradeFee

Description

Source: Postman Polaris-OpenAPI-Order / Account-Asset / tradeFee.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
symbol query string No
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/asset/transaction/history

transaction history

Description

Source: Postman Polaris-OpenAPI-Order / Account-Asset / transaction history.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
pageNum query integer No
pageSize query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script
tokenId query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Convert

POST /openapi/convert/v1/accept-quote

accept quote

Description

Source: Postman Polaris-OpenAPI-Order / Convert / accept quote.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "quoteId": "{{quoteId}}"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/convert/v1/get-quote

get quote

Description

Source: Postman Polaris-OpenAPI-Order / Convert / get quote.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "sourceCurrency": "USDT",
    "targetCurrency": "AUD",
    "sourceAmount": "10"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/convert/v1/get-supported-trading-pairs

supported pairs

Description

Source: Postman Polaris-OpenAPI-Order / Convert / supported pairs.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/convert/v1/query-order-history

order history

Description

Source: Postman Polaris-OpenAPI-Order / Convert / order history.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "page": 1,
    "size": 20
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Fiat

POST /openapi/fiat/v1/cash-out

cash-out

Description

fiatOnly needWrite — careful

Source: Postman Polaris-OpenAPI-Order / Fiat/Write / cash-out.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "currency": "AUD",
    "amount": "10",
    "channelName": "{{fiatChannel}}",
    "channelSubject": "{{fiatSubject}}"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/fiat/v1/details

details

Description

Source: Postman Polaris-OpenAPI-Order / Fiat/Read / details.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
internalOrderId query string No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/fiat/v1/get_qr_code

get_qr_code

Description

Source: Postman Polaris-OpenAPI-Order / Fiat/Read / get_qr_code.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
requestId query string No
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/fiat/v1/get_qr_code/static/list

static qr list

Description

Source: Postman Polaris-OpenAPI-Order / Fiat/Read / static qr list.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
status query string No
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/fiat/v1/history

history

Description

Source: Postman Polaris-OpenAPI-Order / Fiat/Write / history.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/fiat/v1/support-channel

support-channel

Description

Source: Postman Polaris-OpenAPI-Order / Fiat/Write / support-channel.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/fiat/v2/history

history v2

Description

Source: Postman Polaris-OpenAPI-Order / Fiat/Write / history v2.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Fiat Migration

GET /openapi/migration/v4/payout-outlet-categories

payout-outlet-categories

Description

Source: Postman Polaris-OpenAPI-Order / Fiat-Migration/Read / payout-outlet-categories.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/migration/v4/payout-outlet-fees

payout-outlet-fees

Description

Source: Postman Polaris-OpenAPI-Order / Fiat-Migration/Read / payout-outlet-fees.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
currency query string No
payment_outlet query string No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/migration/v4/payout-outlets

payout-outlets

Description

Source: Postman Polaris-OpenAPI-Order / Fiat-Migration/Read / payout-outlets.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/migration/v4/sellorder

create sellorder

Description

Fill real sellorder fields per environment; placeholder body

Source: Postman Polaris-OpenAPI-Order / Fiat-Migration/Write / create sellorder.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "currency": "AUD",
    "amount": "10"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/migration/v4/sellorder

list sellorder

Description

Source: Postman Polaris-OpenAPI-Order / Fiat-Migration/Read / list sellorder.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
limit query integer No
offset query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/migration/v4/sellorder/{sellOrderId}

get sellorder

Description

Source: Postman Polaris-OpenAPI-Order / Fiat-Migration/Read / get sellorder.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
sellOrderId path string No
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/migration/v4/validate-field

validate-field

Description

Source: Postman Polaris-OpenAPI-Order / Fiat-Migration/Write / validate-field.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Market Data

GET /openapi/quote/v1/avgPrice

avgPrice

Description

Source: Postman Polaris-OpenAPI-Order / Market / avgPrice.

Input parameters

Parameter In Type Default Nullable Description
symbol query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/quote/v1/depth

depth

Description

Source: Postman Polaris-OpenAPI-Order / Market / depth.

Input parameters

Parameter In Type Default Nullable Description
limit query integer No
symbol query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/quote/v1/klines

klines

Description

Source: Postman Polaris-OpenAPI-Order / Market / klines.

Input parameters

Parameter In Type Default Nullable Description
interval query string No
limit query integer No
symbol query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/quote/v1/ticker/24hr

ticker 24hr

Description

Source: Postman Polaris-OpenAPI-Order / Market / ticker 24hr.

Input parameters

Parameter In Type Default Nullable Description
symbol query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/quote/v1/ticker/bookTicker

bookTicker

Description

Source: Postman Polaris-OpenAPI-Order / Market / bookTicker.

Input parameters

Parameter In Type Default Nullable Description
symbol query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/quote/v1/ticker/price

ticker price

Description

Source: Postman Polaris-OpenAPI-Order / Market / ticker price.

Input parameters

Parameter In Type Default Nullable Description
symbol query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/quote/v1/trades

trades

Description

Source: Postman Polaris-OpenAPI-Order / Market / trades.

Input parameters

Parameter In Type Default Nullable Description
limit query integer No
symbol query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Transfer

POST /openapi/transfer/v3/transfers

create transfer

Description

Source: Postman Polaris-OpenAPI-Order / Transfer/Write / create transfer.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "client_transfer_id": "doc-7d3e87f6",
    "account": "{{transferAccount}}",
    "target_address": "{{transferTarget}}",
    "amount": "1"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/transfer/v3/transfers

list transfers

Description

Source: Postman Polaris-OpenAPI-Order / Transfer/Read / list transfers.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
page query integer No
per_page query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/transfer/v3/transfers/{transferId}

get transfer by id

Description

Source: Postman Polaris-OpenAPI-Order / Transfer/Read / get transfer by id.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script
transferId path string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Public

GET /openapi/v1/exchangeInfo

exchangeInfo

Description

Source: Postman Polaris-OpenAPI-Order / Public / exchangeInfo.

Input parameters

Parameter In Type Default Nullable Description
symbol query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/pairs

pairs

Description

Source: Postman Polaris-OpenAPI-Order / Public / pairs.

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/ping

ping

Description

Health

Source: Postman Polaris-OpenAPI-Order / Public / ping.

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/time

time

Description

Server time

Source: Postman Polaris-OpenAPI-Order / Public / time.

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/user/ip

user ip

Description

Source: Postman Polaris-OpenAPI-Order / Public / user ip.

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Margin & Fund Collect

POST /openapi/v1/fund-collect/collect-from-sub-account

collect-from-sub-account

Description

Source: Postman Polaris-OpenAPI-Order / Margin-FundCollect/FundCollect-Write / collect-from-sub-account.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "clientRequestId": "doc-fba73094",
    "remark": "doc"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/fund-collect/get-fund-record

get-fund-record

Description

Source: Postman Polaris-OpenAPI-Order / Margin-FundCollect/FundCollect-Read / get-fund-record.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
page query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
size query integer No
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/v1/margin/transfer

margin transfer

Description

Source: Postman Polaris-OpenAPI-Order / Margin-FundCollect/Margin-Write / margin transfer.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "clientTransferId": "doc-e98b8b86",
    "tokenId": "USDT",
    "amount": "1",
    "type": "1"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/margin/transfer/history

margin transfer history

Description

Source: Postman Polaris-OpenAPI-Order / Margin-FundCollect/Margin-Read / margin transfer history.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
current query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
size query integer No
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Spot Trading

GET /openapi/v1/historyOrders

history orders

Description

Historical orders.

Source: Postman Polaris-OpenAPI-Order / Signed-Order / history orders.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
limit query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
symbol query string No
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/myTrades

my trades

Description

Historical trades. symbol required.

Source: Postman Polaris-OpenAPI-Order / Signed-Order / my trades.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
limit query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
symbol query string No
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/openOrders

open orders

Description

List open orders. symbol optional.

Source: Postman Polaris-OpenAPI-Order / Signed-Order / open orders.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
symbol query string No
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

DELETE /openapi/v1/openOrders

cancel all open orders

Description

Cancel all open orders for symbol. confirmCancelAll must be true.

Source: Postman Polaris-OpenAPI-Order / Signed-Order / cancel all open orders.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
confirmCancelAll query string No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
symbol query string No
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/openOrders/all

all open orders (whitelist)

Description

All users open orders for symbol. Caller must be in full.order.read.whitelist.

Source: Postman Polaris-OpenAPI-Order / Signed-Order / all open orders (whitelist).

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
symbol query string No
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/v1/order

place order LIMIT

Description

Place LIMIT order. Params in query. Requires trade-capable API key. Use small size on dev.

Source: Postman Polaris-OpenAPI-Order / Signed-Order / place order LIMIT.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
newOrderRespType query string No
price query string No
quantity query string No
recvWindow query integer No Auto-filled by Pre-request Script
side query string No
signature query string No HMAC-SHA256 hex digest of originStr.
symbol query string No
timeInForce query string No
timestamp query integer No Auto-filled by Pre-request Script
type query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/order

get order

Description

Query one order. orderId or origClientOrderId required.

Source: Postman Polaris-OpenAPI-Order / Signed-Order / get order.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
orderId query string No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

DELETE /openapi/v1/order

cancel order

Description

Cancel one order.

Source: Postman Polaris-OpenAPI-Order / Signed-Order / cancel order.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
orderId query string No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/v1/order/cancelReplace

cancelReplace

Description

Atomic cancel+replace. cancelOrderId or cancelOrigClientOrderId.

Source: Postman Polaris-OpenAPI-Order / Signed-Order / cancelReplace.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
cancelOrderId query string No
cancelReplaceMode query string No
price query string No
quantity query string No
recvWindow query integer No Auto-filled by Pre-request Script
side query string No
signature query string No HMAC-SHA256 hex digest of originStr.
symbol query string No
timeInForce query string No
timestamp query integer No Auto-filled by Pre-request Script
type query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/v1/order/test

order test (validate only)

Description

Validate order params without placing. Returns {}.

Source: Postman Polaris-OpenAPI-Order / Signed-Order / order test (validate only).

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
price query string No
quantity query string No
recvWindow query integer No Auto-filled by Pre-request Script
side query string No
signature query string No HMAC-SHA256 hex digest of originStr.
symbol query string No
timeInForce query string No
timestamp query integer No Auto-filled by Pre-request Script
type query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Sub-Account

GET /openapi/v1/sub-account/asset

asset

Description

Source: Postman Polaris-OpenAPI-Order / SubAccount/Read / asset.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
email query string No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/v1/sub-account/create

create

Description

Source: Postman Polaris-OpenAPI-Order / SubAccount/Write / create.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "accountName": "doc-sub"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/sub-account/list

list

Description

Source: Postman Polaris-OpenAPI-Order / SubAccount/Read / list.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
limit query integer No
page query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/sub-account/transfer/sub-history

sub-history

Description

Source: Postman Polaris-OpenAPI-Order / SubAccount/Read / sub-history.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
limit query integer No
page query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/v1/sub-account/transfer/sub-to-master

sub-to-master

Description

Source: Postman Polaris-OpenAPI-Order / SubAccount/Write / sub-to-master.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "asset": "USDT",
    "amount": "1"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/v1/sub-account/transfer/universal-transfer

universal-transfer

Description

Source: Postman Polaris-OpenAPI-Order / SubAccount/Write / universal-transfer.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "toEmail": "{{subEmail}}",
    "asset": "USDT",
    "amount": "1"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/sub-account/transfer/universal-transfer-history

universal-transfer-history

Description

Source: Postman Polaris-OpenAPI-Order / SubAccount/Read / universal-transfer-history.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
limit query integer No
page query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/sub-account/wallet/deposit/address

deposit address

Description

Source: Postman Polaris-OpenAPI-Order / SubAccount/Read / deposit address.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
coin query string No
email query string No
network query string No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v1/sub-account/wallet/deposit/history

deposit history

Description

Source: Postman Polaris-OpenAPI-Order / SubAccount/Read / deposit history.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
email query string No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

User Data Stream

POST /openapi/v1/userDataStream

create listenKey

Description

validKeyOnly — API key header, no signature. Saves listenKey to environment.

Source: Postman Polaris-OpenAPI-Order / ListenKey / create listenKey.

Also in Postman folder OpenAPI-WS.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyOnly header string N/A No API Key only (validKeyOnly). No signature. listenKey lifecycle.

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

PUT /openapi/v1/userDataStream

keepalive listenKey

Description

Extend listenKey TTL. Call ~every 30 minutes.

Source: Postman Polaris-OpenAPI-Order / ListenKey / keepalive listenKey.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyOnly header string N/A No API Key only (validKeyOnly). No signature. listenKey lifecycle.
listenKey query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

DELETE /openapi/v1/userDataStream

close listenKey

Description

Invalidate listenKey.

Source: Postman Polaris-OpenAPI-Order / ListenKey / close listenKey.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyOnly header string N/A No API Key only (validKeyOnly). No signature. listenKey lifecycle.
listenKey query string No

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Payment Request

POST /openapi/v3/payment-request/delete-payment-request

delete

Description

Source: Postman Polaris-OpenAPI-Order / PaymentRequest/Write / delete.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "id": "{{paymentRequestId}}"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/v3/payment-request/get-payment-request

get/list

Description

Source: Postman Polaris-OpenAPI-Order / PaymentRequest/Read / get/list.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
limit query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/v3/payment-request/payment-request-reminder

reminder

Description

Source: Postman Polaris-OpenAPI-Order / PaymentRequest/Write / reminder.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "id": "{{paymentRequestId}}"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/v3/payment-request/payment-requests

create

Description

Source: Postman Polaris-OpenAPI-Order / PaymentRequest/Write / create.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "payer_contact_info": "{{payerContact}}",
    "receiving_account": "{{receivingAccount}}",
    "amount": "10",
    "message": "doc"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Wallet

GET /openapi/wallet/v1/config/getall

config getall

Description

Source: Postman Polaris-OpenAPI-Order / Wallet / config getall.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/wallet/v1/deposit/address

deposit address

Description

Source: Postman Polaris-OpenAPI-Order / Wallet / deposit address.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
coin query string No
network query string No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/wallet/v1/deposit/history

deposit history

Description

Source: Postman Polaris-OpenAPI-Order / Wallet / deposit history.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
coin query string No
limit query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

POST /openapi/wallet/v1/withdraw/apply

withdraw apply

Description

JSON body + HMAC (query timestamp + body)

Source: Postman Polaris-OpenAPI-Order / Wallet-Write / withdraw apply.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Request body

{
    "coin": "USDT",
    "network": "TRC20",
    "address": "{{withdrawAddress}}",
    "amount": "10"
}
Schema of the request body 
{
    "type": "object",
    "additionalProperties": true
}

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

GET /openapi/wallet/v1/withdraw/history

withdraw history

Description

Source: Postman Polaris-OpenAPI-Order / Wallet / withdraw history.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyHmac header string N/A No API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
coin query string No
limit query integer No
recvWindow query integer No Auto-filled by Pre-request Script
signature query string No HMAC-SHA256 hex digest of originStr.
timestamp query integer No Auto-filled by Pre-request Script

Responses

Schema of the response body 
{
    "type": "object",
    "additionalProperties": true
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}


{
    "code": 0,
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer"
        },
        "msg": {
            "type": "string"
        }
    },
    "required": [
        "code",
        "msg"
    ]
}

Schemas

ErrorBody

Name Type Description
code integer
msg string

Security schemes

Name Type Scheme Description
ApiKeyHmac apiKey API Key + HMAC-SHA256 signature. originStr = queryString(excluding signature) + body.
ApiKeyOnly apiKey API Key only (validKeyOnly). No signature. listenKey lifecycle.

Tags

Name Description
Public
Market Data
Spot Trading
User Data Stream
Account
Wallet
Convert
Fiat
Fiat Migration
Sub-Account
Transfer
Margin & Fund Collect
Payment Request