Skip to navigation
API ReferenceSub Account

Get sub-account list

Retrieve the list of sub-accounts belonging to the master account, along with their status and metadata. Applies only to master accounts.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Query parameters

enablestringOptional

Sub-account status. true: Normal; false: Frozen.

subAcctstringOptional

Sub-account name.

afterstringOptional

Query sub-accounts created before this timestamp (Unix timestamp in milliseconds), e.g. 1597026383085.

beforestringOptional

Query sub-accounts created after this timestamp (Unix timestamp in milliseconds), e.g. 1597026383085.

limitstringOptional
Number of results per request. The maximum is 100 and the default is 100.

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional