Query user information
Rate limit: every seconds
API Overview
HTTP method
GET
Path
/api/v3/account
Summary
Returns data associated with the user's exchange account.
API description
HTTP Header
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| X-API-KEY | string | Y | ApiKey | "HlkcGxbqBeaF76j4rvPaOasyfPwnkQ 6B6DQ6THZWbvrAGxzEdulXQvOKLrRW ZLnN" |
Request parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| owner | string | Y | Ethereum address | "0x123456" |
Request example
HTTP
CURL
GET http://aa90cd58e38014a1b864ddc488129b7a-624979106.us-east-2.elb.amazonaws.com/api/v3/account?owner=0x123456 HTTP/1.1
Host: aa90cd58e38014a1b864ddc488129b7a-624979106.us-east-2.elb.amazonaws.com
Connection: keep-alive
Accept: */*
Accept-Encoding: gzip, deflate, br
Accept-Language: zh,en;q=0.9
X-API-KEY: sra1aavfacurl -H "X-API-KEY:sra1aavfa" http://aa90cd58e38014a1b864ddc488129b7a-624979106.us-east-2.elb.amazonaws.com/api/v3/account\?owner\=0x123456Response fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| accountId | integer | Y | Account ID | 10 |
| owner | string | Y | Ethereum address | "0xABCD" |
| frozen | boolean | Y | The frozen state of the account, true stands for frozen, if the account is frozen, the user cant submit order. | "false" |
| publicKey | PublicKey | Y | The user's public key | "{x:0x241707bcc6d7a4c cf10304be248d343a527 e85f61b45d721544d027 cc1f2fb5f,y:0x302f3a 521dbdd1d0eb1944c832 3d4ac3b3e9c9201f4aa4 3a2565054886369d9c}" |
| tags | string | N | Comma separated list of tags such as VIP levels, etc | "vip_1" |
| nonce | integer | Y | field.DexAccountV3.nonce | 0 |
Response example
{
"accountId" : 10,
"owner" : "0xABCD",
"frozen" : false,
"publicKey" : {
"x" : "0x241707bcc6d7a4ccf10304be248d343a527e85f61b45d721544d027cc1f2fb5f",
"y" : "0x302f3a521dbdd1d0eb1944c8323d4ac3b3e9c9201f4aa43a2565054886369d9c"
},
"tags" : "vip_1",
"nonce" : 0
}
Status code
| Value | Description |
|---|---|
| 100000 | Unknown error |
| 101001 | The address was not found |
| 101002 | User not found |
Model
PublicKey
Describes the users public key which is a point of the selected eclipse curve.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| x | string | Y | The public keys x part. | "0x241707bcc6d7a4ccf1 0304be248d343a527e85 f61b45d721544d027cc1 f2fb5f" |
| y | string | Y | The public keys y part. | "0x302f3a521dbdd1d0eb 1944c8323d4ac3b3e9c9 201f4aa43a2565054886 369d9c" |