Fast API

Endpoint

Download schema

Create API key for User

POST

/v1/api-key/create

https://api.binance.com

Create API key for User › Headers

Authorization

string · required

Bearer access token.

Example: Bearer {access_token}

Create API key for User › Request Body

apiName

string · required

custom api name, can be repeated

Example: my-api-name

enableTrade

boolean · required

true or false.

Example: true

enableFutureTrade

boolean · required

true or false.

Example: true

publicKey

string · required

Your custom public key. The server side will use it to encrypt the apikey, and client decrypts with a private key. Use RSA algorithm, the keysize is customized with client, usually 1024 or 2048 (Reference).

Example: PUBLIC_KEY

enableMargin

boolean

If it's not sent or the user doesn't have Margin account, it will be false by default.

Example: false

enableEuropeanOptions

boolean

If it's not sent or the user doesn't have Options account, it will be false by default.

Example: false

status

string

1 or null = Access IP unrestricted, 2 = Trusted IPs only, 3 = Trusted Third Party IPs only. If you want to enable any Trade permission(including Spot, Margin or Futures), you must restrict the IP access.

Example: 1

ipAddress

string

Trusted IPs. Can be added in batches, separated by commas. Max 30 for an API key

Example: 54.128.193.28

thirdPartyName

string

Third party name must match the name in the server side.

Example: null

apiKeyPublicKey

string

The public key for asymmetrical key type(Ed25519 and RSA). Please see https://www.binance.com/en/support/faq/detail/6b9a63f1e3384cf48a2eedb82767a69a

Example: API_KEY_PUBLIC_KEY

Create API key for User › Responses

200

Create API key for User

code

string

Example: 000000

message

string

Example: null

object

apiKey

string

Example: ZN02rGiWOE6*****yjOZg==

apiName

string

Example: testoauth1

secretKey

string

Example: rH1cO1374UhZXfn2*********3EJjg/JT6gg==

enableTrade

boolean

Example: true

enableFutureTrade

boolean

Example: true

enableMargin

boolean

Example: false

enableEuropeanOptions

boolean

Example: true

createTime

integer · int64

Example: 1717746281067

success

boolean

Example: true

POST/v1/api-key/create

curl --request POST \
  --url https://api.binance.com/v1/api-key/create \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data apiName=my-api-name \
  --data enableTrade=true \
  --data enableFutureTrade=true \
  --data publicKey=PUBLIC_KEY

Example Request Body

{
  "apiName": "my-api-name",
  "enableTrade": true,
  "enableFutureTrade": true,
  "publicKey": "PUBLIC_KEY"
}

json

Example Responses

{
  "code": "000000",
  "message": "null",
  "data": {
    "apiKey": "ZN02rGiWOE6*****yjOZg==",
    "apiName": "testoauth1",
    "secretKey": "rH1cO1374UhZXfn2*********3EJjg/JT6gg==",
    "enableTrade": true,
    "enableFutureTrade": true,
    "enableMargin": false,
    "enableEuropeanOptions": true,
    "createTime": 1717746281067
  },
  "success": true
}

json

application/json

Get User Status

GET

/v1/api-key/user-status

https://api.binance.com

Get User Status › Headers

Authorization

string · required

Bearer access token.

Example: Bearer {access_token}

Get User Status › Responses

200

Get User Status

code

string

Example: 000000

message

string

Example: null

object

isExistFutureAccount

boolean

Example: true

success

boolean

Example: true

Create API key for User

POST

/v1/api-key/create

https://api.binance.com

Create API key for User › Headers

Authorization

string · required

Bearer access token.

Example: Bearer {access_token}

Create API key for User › Request Body

apiName

string · required

custom api name, can be repeated

Example: my-api-name

enableTrade

boolean · required

true or false.

Example: true

enableFutureTrade

boolean · required

true or false.

Example: true

publicKey

string · required

Example: PUBLIC_KEY

enableMargin

boolean

If it's not sent or the user doesn't have Margin account, it will be false by default.

Example: false

enableEuropeanOptions

boolean

If it's not sent or the user doesn't have Options account, it will be false by default.

Example: false

status

string

Example: 1

ipAddress

string

Trusted IPs. Can be added in batches, separated by commas. Max 30 for an API key

Example: 54.128.193.28

thirdPartyName

string

Third party name must match the name in the server side.

Example: null

apiKeyPublicKey

string

The public key for asymmetrical key type(Ed25519 and RSA). Please see https://www.binance.com/en/support/faq/detail/6b9a63f1e3384cf48a2eedb82767a69a

Example: API_KEY_PUBLIC_KEY

Create API key for User › Responses

200

Create API key for User

code

string

Example: 000000

message

string

Example: null

object

apiKey

string

Example: ZN02rGiWOE6*****yjOZg==

apiName

string

Example: testoauth1

secretKey

string

Example: rH1cO1374UhZXfn2*********3EJjg/JT6gg==

enableTrade

boolean

Example: true

enableFutureTrade

boolean

Example: true

enableMargin

boolean

Example: false

enableEuropeanOptions

boolean

Example: true

createTime

integer · int64

Example: 1717746281067

success

boolean

Example: true

Get User Status

GET

/v1/api-key/user-status

https://api.binance.com

Get User Status › Headers

Authorization

string · required

Bearer access token.

Example: Bearer {access_token}

Get User Status › Responses

200

Get User Status

code

string

Example: 000000

message

string

Example: null

object

isExistFutureAccount

boolean

Example: true

success

boolean

Example: true