API Reference

Create an API for Trading Portfolio

Create an API for Trading Portfolio by a primary user

🚧

Tips

Applies to primary user's API Key only. Permission: TRADE.

Rate Limit: 3 requests per 10 seconds

Request

Field nameTypeNecessaryRemarks
portfolioIdLongYportfolioId
apiNameStringYAPI Key note
ipStringNip address
permissionStringNREAD,TRANSFER,WITHDRAW,TRADE

Response

Field nameTypeRemarks
portfolioIdLongportfolioId
apiNameStringAPI Key note
accessKeyStringaccessKey
secretKeyStringsecretKey
statusIntegerstatus: 1 normal, 2 frozen
ipStringip list
permissionStringREAD,TRANSFER,WITHDRAW,TRADE
createdAtLongcreate timestamp
updatedAtLongupdatedAt timestamp
  • The limit creation for LTP API and Trading Portfolio API is a maximum of 10. By default, only one Transfer permission API, one Withdraw permission API, and one Trade permission API are allowed, or one API with transfer + withdraw + trade permission.
  • Permission:
    • Read: Read account and transaction data of the Trading Portfolio.
    • Transfer: Support transfer between different ‘account type’(Binance or OKX) of the API-owned Trading Portfolio
    • Withdraw: Only support withdrawal from different ‘account type’(Binance or OKX) of the API-owned Trading Portfolio
      Trade
    • Trade: Only support placing orders on the API-owned Trading Portfolio.

The read permission is automatically granted by default and permissions can be directly separated by commas.

Language