openAPI-StarEx

# Account Interface

# Querying Assets

GET /v1/account/balance

Module Type Resource Isolation Rate Limit
Account(ACCOUNT) Query(QUERY) Coin(COIN) 1

# Parameters

Name Type Required Description
coins Array Yes List of currencies

# Response Parameters

Name Type Description
coin String Cryptocurrency
balance Decimal Available Balance
freeze Decimal Frozen Amount

# Request Example

GET /v1/account/balance?coins=USDT,BTC

# Response Example

{
	"code":"200",
	"message":"",
	"data":[{
		"coin":"USDT",
		"balance":"55.8",
		"freeze":"44.2"
	},{
		"coin":"BTC",
		"balance":"0.012",
		"freeze":"0.008"
	}]
}

# Querying Transfer Records

GET /v1/account/transfer/page

Module Type Resource Isolation Rate Limit
Account(ACCOUNT) Query(QUERY) Coin(COIN) 5

# Parameters

Name Type Required Description
pageIndex Int No (Public) Page index for pagination, defaults to 1 if not provided
pageSize Int No (Public) Page size for pagination, defaults to 100 if not provided
coins Array Yes List of currencies
from TransactionType No Outgoing transaction type
to TransactionType No Incoming transaction type

# Response Parameters

Name Type Description
transactionNo String Transaction number
coin String Cryptocurrency
amount Decimal Transfer amount
from TransactionType Outgoing transaction type
to TransactionType Incoming transaction type
timestamp Long Transfer time

# Request Example

GET /v1/account/transfer/page?coins=USDT,BTC&pageIndex=1&pageSize=2

# Response Example

{
	"code":"200",
	"message":"OK",
	"timestamp":"1684909359187",
	"data":{
		"total":5,
		"list":[{
			"transactionNo:"TO00000001",
			"coin":"USDT",
			"amount":"1.5",
			"from":"EXCHANGE",
			"to":"OTC",
            "timestamp":1972196932
		},{
			"transactionNo:"TO00000002",
			"coin":"BTC",
			"amount":"0.002",
			"from":"EXCHANGE",
			"to":"OTC",
            "timestamp":1972197631
		}]
	}
}

# Submit Transfer

POST /v1/account/transfer/submit

Module Type Resource Isolation Rate Limit
Account(ACCOUNT) Submit(SUBMIT) Coin(COIN) 5

# Parameters

Name Type Required Description
coin String Yes Cryptocurrency
amount Decimal Yes Transfer Amount
from TransactionType Yes Outgoing Transaction Type
to TransactionType Yes Incoming Transaction Type

# Response Parameters

Name Type Description
transactionNo String Transaction number
coin String Cryptocurrency
amount Decimal Transfer amount
from TransactionType Outgoing transaction type
to TransactionType Incoming transaction type
timestamp Long Transfer time

# Request Example

POST /v1/account/transfer/submit
{
	"coin":"USDT",
	"amount":"1",
	"from":"EXCHANGE",
	"to":"OTC"
}

# Response Example

{
	"code":"200",
	"message":"OK",
	"timestamp":"1684909359187",
	"data":{
		"transactionNo:"TO00000002",
		"coin":"BTC",
		"amount":"0.002",
		"from":"EXCHANGE",
		"to":"OTC",
        "timestamp":198654344
	}
}

# Transaction Pagination

GET /v1/account/waterbill/page

Module Type Resource Isolation Rate Limit
Account(ACCOUNT) Submit(SUBMIT) Coin(COIN) 5

# Parameters

Name Type Required Description
pageIndex Int No (Public) Index of pagination. Default is 1 if not filled
pageSize Int No (Public) Page size for pagination. Default is 100 if not filled
coin String Yes Cryptocurrency

# Response Parameters

Name Type Description
transactionNo String Transaction Number
coin String Cryptocurrency
amount Decimal Amount
before BalanceSnapshot Asset Snapshot Before the Transaction
after BalanceSnapshot Asset Snapshot After the Transaction
| balance Decimal Snapshot Balance: Available Balance
| freeze Decimal Snapshot Balance: Frozen Amount
version Long Transaction Version Number
timestamp Long Transaction Timestamp

# Request Example

GET /v1/account/waterbill/page?coin=USDT&pageSize=1&pageIndex=1

# Response Example

{
    "code":"200",
    "message":"OK",
    "timestamp":"1684909359187",
    "data":{
        "total":5,
        "list":[
            {
                "transactionNo":"TO00000001",
                "coin":"USDT",
                "amount":"1.5",
                "before":{
                    "balance":"1.5",
                    "freeze":"0"
                },
                "after":{
                    "balance":"0",
                    "freeze":"1.5"
                },
                "version":2,
                "timestamp":1987123692
            }
        ]
    }
}

← Spot Market Data →