mirror of
https://github.com/discountry/ritmex-bot.git
synced 2026-09-09 16:28:06 +00:00
DisneyandGitHub
d6399b92aa
* add docs * Add Binance exchange support - Updated the environment configuration to include Binance as a selectable exchange option. - Enhanced the README documentation to reflect the addition of Binance. - Implemented the Binance exchange adapter and integrated it into the existing exchange framework. - Modified the basis arbitrage strategy to support Binance alongside existing exchanges. - Added tests to ensure proper functionality and integration of Binance within the trading system. * Enhance README with detailed Binance exchange configuration - Added comprehensive instructions for setting up Binance as an exchange option. - Included environment variable specifications for API keys, market types, and trading symbols. - Provided examples for both perpetual and spot trading strategies. - Clarified the use of WebSocket and REST for the Binance adapter. * Enhance exchange support and testing framework - Added a new test suite for exchange contracts to ensure consistency and functionality across supported exchanges. - Refactored exchange ID handling to utilize a centralized list of supported exchanges, improving maintainability. - Updated CLI argument parsing and help documentation to reflect the new exchange structure. - Introduced utility functions for validating supported exchanges and their display names. - Enhanced the BasisApp and strategy runner to leverage the new exchange validation logic. - Added a new test command for running exchange-related tests. * Refactor exchange contract tests and update CLI commands - Removed the trailing supported exchanges set and simplified the logic for trailing stop support in the exchange contract tests. - Updated the test command for exchange contracts to exclude unnecessary tests, streamlining the testing process. - Enhanced test descriptions for clarity and improved understanding of the functionality being tested.
601 lines
24 KiB
Markdown
601 lines
24 KiB
Markdown
---
|
||
title: "Request Security | Binance Open Platform"
|
||
source: "https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security"
|
||
fetched_at: "2026-02-26T10:38:09.213Z"
|
||
---
|
||
- Each endpoint has a security type indicating required API key permissions, shown next to the endpoint name (e.g., [New order (TRADE)](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security)).
|
||
- If unspecified, the security type is `NONE`.
|
||
- Except for `NONE`, all endpoints with a security type are considered `SIGNED` requests (i.e. including a `signature`), except for [listenKey management](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security).
|
||
- Secure endpoints require a valid API key to be specified and authenticated.
|
||
- API keys can be created on the [API Management](https://www.binance.com/en/support/faq/360002502072) page of your Binance account.
|
||
- **Both API key and secret key are sensitive.** Never share them with anyone. If you notice unusual activity in your account, immediately revoke all the keys and contact Binance support.
|
||
- API keys can be configured to allow access only to certain types of secure endpoints.
|
||
- For example, you can have an API key with `TRADE` permission for trading, while using a separate API key with `USER_DATA` permission to monitor your order status.
|
||
- By default, an API key cannot `TRADE`. You need to enable trading in API Management first.
|
||
|
||
Security type
|
||
|
||
Description
|
||
|
||
`NONE`
|
||
|
||
Public market data
|
||
|
||
`TRADE`
|
||
|
||
Trading on the exchange, placing and canceling orders
|
||
|
||
`USER_DATA`
|
||
|
||
Private account information, such as order status and your trading history
|
||
|
||
`USER_STREAM`
|
||
|
||
Managing User Data Stream subscriptions
|
||
|
||
### SIGNED Endpoint security[](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security)
|
||
|
||
- `SIGNED` endpoints require an additional parameter, `signature`, to be sent in the `query string` or `request body`.
|
||
|
||
#### Signature Case Sensitivity[](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security)
|
||
|
||
- **HMAC:** Signatures generated using HMAC are **not case-sensitive**. This means the signature string can be verified regardless of letter casing.
|
||
- **RSA:** Signatures generated using RSA are **case-sensitive**.
|
||
- **Ed25519:** Signatures generated using Ed25519 are also **case-sensitive**
|
||
|
||
Please consult [SIGNED request example (HMAC)](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security), [SIGNED request example (RSA)](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security), and [SIGNED request example (Ed25519)](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security) on how to compute signature, depending on which API key type you are using.
|
||
|
||
### Timing security[](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security)
|
||
|
||
- `SIGNED` requests also require a `timestamp` parameter which should be the current timestamp either in milliseconds or microseconds. (See [General API Information](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security))
|
||
- An additional optional parameter, `recvWindow`, specifies for how long the request stays valid and may only be specified in milliseconds.
|
||
- `recvWindow` supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
|
||
- If `recvWindow` is not sent, **it defaults to 5000 milliseconds**.
|
||
- Maximum `recvWindow` is 60000 milliseconds.
|
||
- Request processing logic is as follows:
|
||
|
||
```
|
||
serverTime = getCurrentTime()if (timestamp < (serverTime + 1 second) && (serverTime - timestamp) <= recvWindow) { // begin processing request serverTime = getCurrentTime() if (serverTime - timestamp) <= recvWindow { // forward request to Matching Engine } else { // reject request } // finish processing request} else { // reject request}
|
||
```
|
||
|
||
**Serious trading is about timing.** Networks can be unstable and unreliable, which can lead to requests taking varying amounts of time to reach the servers. With `recvWindow`, you can specify that the request must be processed within a certain number of milliseconds or be rejected by the server.
|
||
|
||
**It is recommended to use a small recvWindow of 5000 or less! The max cannot go beyond 60,000!**
|
||
|
||
### SIGNED Endpoint Examples for POST /api/v3/order[](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security)
|
||
|
||
#### HMAC Keys[](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security)
|
||
|
||
The signature payload of your request is the query string concatenated without separator to the HTTP body. Any non-ASCII character must be percent-encoded before signing.
|
||
|
||
Here is a step-by-step example of how to send a valid signed payload from the Linux command line using `echo`, `openssl`, and `curl`. There is one example with a symbol name comprised entirely of ASCII characters and one example with a symbol name containing non-ASCII characters.
|
||
|
||
Example API key and secret key:
|
||
|
||
Key
|
||
|
||
Value
|
||
|
||
`apiKey`
|
||
|
||
vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A
|
||
|
||
`secretKey`
|
||
|
||
NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j
|
||
|
||
**WARNING: DO NOT SHARE YOUR API KEY AND SECRET KEY WITH ANYONE.**
|
||
|
||
The example keys are provided here only for illustrative purposes.
|
||
|
||
Example of request with a symbol name comprised entirely of ASCII characters:
|
||
|
||
Parameter
|
||
|
||
Value
|
||
|
||
`symbol`
|
||
|
||
LTCBTC
|
||
|
||
`side`
|
||
|
||
BUY
|
||
|
||
`type`
|
||
|
||
LIMIT
|
||
|
||
`timeInForce`
|
||
|
||
GTC
|
||
|
||
`quantity`
|
||
|
||
1
|
||
|
||
`price`
|
||
|
||
0.1
|
||
|
||
`recvWindow`
|
||
|
||
5000
|
||
|
||
`timestamp`
|
||
|
||
1499827319559
|
||
|
||
Example of a request with a symbol name containing non-ASCII characters:
|
||
|
||
Parameter
|
||
|
||
Value
|
||
|
||
`symbol`
|
||
|
||
１２３４５６
|
||
|
||
`side`
|
||
|
||
BUY
|
||
|
||
`type`
|
||
|
||
LIMIT
|
||
|
||
`timeInForce`
|
||
|
||
GTC
|
||
|
||
`quantity`
|
||
|
||
1
|
||
|
||
`price`
|
||
|
||
0.1
|
||
|
||
`recvWindow`
|
||
|
||
5000
|
||
|
||
`timestamp`
|
||
|
||
1499827319559
|
||
|
||
**Step 1: Construct the signature payload**
|
||
|
||
1. Format parameters as `parameter=value` pairs separated by `&`.
|
||
2. Percent-encode the string.
|
||
|
||
For the first set of example parameters (ASCII only), the `parameter=value` string should look like this:
|
||
|
||
```
|
||
symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000×tamp=1499827319559
|
||
```
|
||
|
||
After percent-encoding, the signature payload should look like this:
|
||
|
||
```
|
||
symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000×tamp=1499827319559
|
||
```
|
||
|
||
For the second set of example parameters (some non-ASCII characters), the `parameter=value` string should look like this:
|
||
|
||
```
|
||
symbol=１２３４５６&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000×tamp=1499827319559
|
||
```
|
||
|
||
After percent-encoding, the signature payload should look like this:
|
||
|
||
```
|
||
symbol=%EF%BC%91%EF%BC%92%EF%BC%93%EF%BC%94%EF%BC%95%EF%BC%96&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000×tamp=1499827319559
|
||
```
|
||
|
||
**Step 2: Compute the signature**
|
||
|
||
1. Use the `secretKey` of your API key as the signing key for the HMAC-SHA-256 algorithm.
|
||
2. Sign the signature payload constructed in Step 1.
|
||
3. Encode the HMAC-SHA-256 output as a hex string.
|
||
|
||
Note that `secretKey` and the payload are **case-sensitive**, while the resulting signature value is case-insensitive.
|
||
|
||
**Example commands**
|
||
|
||
For the first set of example parameters (ASCII only):
|
||
|
||
```
|
||
$ echo -n "symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000×tamp=1499827319559" | openssl dgst -sha256 -hmac "NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j"c8db56825ae71d6d79447849e617115f4a920fa2acdcab2b053c4b2838bd6b71
|
||
```
|
||
|
||
For the second set of example parameters (some non-ASCII characters):
|
||
|
||
```
|
||
$ echo -n "symbol=%EF%BC%91%EF%BC%92%EF%BC%93%EF%BC%94%EF%BC%95%EF%BC%96&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000×tamp=1499827319559" | openssl dgst -sha256 -hmac "NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j"e1353ec6b14d888f1164ae9af8228a3dbd508bc82eb867db8ab6046442f33ef3
|
||
```
|
||
|
||
**Step 3: Add signature to the request**
|
||
|
||
Complete the request by adding the `signature` parameter to the query string.
|
||
|
||
For the first set of example parameters (ASCII only):
|
||
|
||
```
|
||
curl -s -v -H "X-MBX-APIKEY: $apiKey" -X POST "https://api.binance.com/api/v3/order?symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000×tamp=1499827319559&signature=c8db56825ae71d6d79447849e617115f4a920fa2acdcab2b053c4b2838bd6b71"
|
||
```
|
||
|
||
For the second set of example parameters (some non-ASCII characters)
|
||
|
||
```
|
||
curl -s -v -H "X-MBX-APIKEY: $apiKey" -X POST "https://api.binance.com/api/v3/order?symbol=%EF%BC%91%EF%BC%92%EF%BC%93%EF%BC%94%EF%BC%95%EF%BC%96&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000×tamp=1499827319559&signature=e1353ec6b14d888f1164ae9af8228a3dbd508bc82eb867db8ab6046442f33ef3"
|
||
```
|
||
|
||
Here is a sample Bash script performing all the steps above:
|
||
|
||
```
|
||
apiKey="vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A"secretKey="NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j"payload="symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000×tamp=1499827319559"# Sign the requestsignature=$(echo -n "$payload" | openssl dgst -sha256 -hmac "$secretKey")signature=${signature#*= } # Keep only the part after the "= "# Send the requestcurl -H "X-MBX-APIKEY: $apiKey" -X POST "https://api.binance.com/api/v3/order?$payload&signature=$signature"
|
||
```
|
||
|
||
#### RSA Keys[](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security)
|
||
|
||
The signature payload of your request is the query string concatenated without separator to the HTTP body. Any non-ASCII character must be percent-encoded before signing.
|
||
|
||
To get your API key, you need to upload your RSA Public Key to your account and a corresponding API key will be provided for you.
|
||
|
||
Only `PKCS#8` keys are supported.
|
||
|
||
There is one example with a symbol name comprised entirely of ASCII characters and one example with a symbol name containing non-ASCII characters.
|
||
|
||
These examples assume the private key is stored in the file `./test-prv-key.pem`.
|
||
|
||
Key
|
||
|
||
Value
|
||
|
||
`apiKey`
|
||
|
||
CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ
|
||
|
||
Example of request with a symbol name comprised entirely of ASCII characters:
|
||
|
||
Parameter
|
||
|
||
Value
|
||
|
||
`symbol`
|
||
|
||
BTCUSDT
|
||
|
||
`side`
|
||
|
||
SELL
|
||
|
||
`type`
|
||
|
||
LIMIT
|
||
|
||
`timeInForce`
|
||
|
||
GTC
|
||
|
||
`quantity`
|
||
|
||
1
|
||
|
||
`price`
|
||
|
||
0.2
|
||
|
||
`timestamp`
|
||
|
||
1668481559918
|
||
|
||
`recvWindow`
|
||
|
||
5000
|
||
|
||
Example of a request with a symbol name containing non-ASCII characters:
|
||
|
||
Parameter
|
||
|
||
Value
|
||
|
||
`symbol`
|
||
|
||
１２３４５６
|
||
|
||
`side`
|
||
|
||
SELL
|
||
|
||
`type`
|
||
|
||
LIMIT
|
||
|
||
`timeInForce`
|
||
|
||
GTC
|
||
|
||
`quantity`
|
||
|
||
1
|
||
|
||
`price`
|
||
|
||
0.2
|
||
|
||
`timestamp`
|
||
|
||
1668481559918
|
||
|
||
`recvWindow`
|
||
|
||
5000
|
||
|
||
**Step 1: Construct the signature payload**
|
||
|
||
1. Format parameters as `parameter=value` pairs separated by `&`.
|
||
2. Percent-encode the string.
|
||
|
||
For the first set of example parameters (ASCII only), the `parameter=value` string should look like this:
|
||
|
||
```
|
||
symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000
|
||
```
|
||
|
||
After percent-encoding, the signature payload should look like this:
|
||
|
||
```
|
||
symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000
|
||
```
|
||
|
||
For the second set of example parameters (some non-ASCII characters), the `parameter=value` string should look like this:
|
||
|
||
```
|
||
symbol=１２３４５６=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000
|
||
```
|
||
|
||
After percent-encoding, the signature payload should look like this:
|
||
|
||
```
|
||
symbol=%EF%BC%91%EF%BC%92%EF%BC%93%EF%BC%94%EF%BC%95%EF%BC%96&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000
|
||
```
|
||
|
||
**Step 2: Compute the signature**
|
||
|
||
1. Sign the signature payload constructed in Step 1 using the RSASSA-PKCS1-v1\_5 algorithm with SHA-256 hash function.
|
||
2. Encode the output in base64.
|
||
|
||
Note that the payload and the resulting `signature` are **case-sensitive**.
|
||
|
||
For the first set of example parameters (ASCII only):
|
||
|
||
```
|
||
$ echo -n 'symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000' | openssl dgst -sha256 -sign ./test-prv-key.pem | openssl enc -base64 -A | tr -d '\n'HZ8HOjiJ1s/igS9JA+n7+7Ti/ihtkRF5BIWcPIEluJP6tlbFM/Bf44LfZka/iemtahZAZzcO9TnI5uaXh3++lrqtNonCwp6/245UFWkiW1elpgtVAmJPbogcAv6rSlokztAfWk296ZJXzRDYAtzGH0gq7CgSJKfH+XxaCmR0WcvlKjNQnp12/eKXJYO4tDap8UCBLuyxDnR7oJKLHQHJLP0r0EAVOOSIbrFang/1WOq+Jaq4Efc4XpnTgnwlBbWTmhWDR1pvS9iVEzcSYLHT/fNnMRxFc7u+j3qI//5yuGuu14KR0MuQKKCSpViieD+fIti46sxPTsjSemoUKp0oXA==
|
||
```
|
||
|
||
For the second set of example parameters (some non-ASCII characters):
|
||
|
||
```
|
||
$ echo -n 'symbol=%EF%BC%91%EF%BC%92%EF%BC%93%EF%BC%94%EF%BC%95%EF%BC%96&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000' | openssl dgst -sha256 -sign ./test-prv-key.pem | openssl enc -base64 -A | tr -d '\n'qJtv66wyp/1mZE+mIFAAMUoTe8xkmLN7/eAZjuC9x1ocxovItHLl/sNK7Wq8QjgiHqGn0bb8P7yVvGBEd1gFe71NQ8aM0M+JNIMz5UFxfeA53rXjFlvsyH1Sig+OuO9Nz5nhCaJ6bEfj2iuv7w27pB3L8MVqmoCi6D9C/QMiLxtPaR70CxtnvoOlIgPmpv2bQy029A31NEK19ieVLkoyp1EUkXRaX3v0mohx8yMnUG1dhX9nUg3Oy8TYZ03DQy7kHDGkMKisNX7rt/GuGx1HIgjFclDGLsbAFIodvSLjm9FbseasMELoxlAJDlwRnW8zo5sQmL0Fz7ao935QBynrng==
|
||
```
|
||
|
||
3. Percent-encode the base64 string.
|
||
|
||
For the first set of example parameters (ASCII only):
|
||
|
||
```
|
||
HZ8HOjiJ1s%2FigS9JA%2Bn7%2B7Ti%2FihtkRF5BIWcPIEluJP6tlbFM%2FBf44LfZka%2FiemtahZAZzcO9TnI5uaXh3%2B%2BlrqtNonCwp6%2F245UFWkiW1elpgtVAmJPbogcAv6rSlokztAfWk296ZJXzRDYAtzGH0gq7CgSJKfH%2BXxaCmR0WcvlKjNQnp12%2FeKXJYO4tDap8UCBLuyxDnR7oJKLHQHJLP0r0EAVOOSIbrFang%2F1WOq%2BJaq4Efc4XpnTgnwlBbWTmhWDR1pvS9iVEzcSYLHT%2FfNnMRxFc7u%2Bj3qI%2F%2F5yuGuu14KR0MuQKKCSpViieD%2BfIti46sxPTsjSemoUKp0oXA%3D%3D
|
||
```
|
||
|
||
For the second set of example parameters (some non-ASCII characters):
|
||
|
||
```
|
||
qJtv66wyp%2F1mZE%2BmIFAAMUoTe8xkmLN7%2FeAZjuC9x1ocxovItHLl%2FsNK7Wq8QjgiHqGn0bb8P7yVvGBEd1gFe71NQ8aM0M%2BJNIMz5UFxfeA53rXjFlvsyH1Sig%2BOuO9Nz5nhCaJ6bEfj2iuv7w27pB3L8MVqmoCi6D9C%2FQMiLxtPaR70CxtnvoOlIgPmpv2bQy029A31NEK19ieVLkoyp1EUkXRaX3v0mohx8yMnUG1dhX9nUg3Oy8TYZ03DQy7kHDGkMKisNX7rt%2FGuGx1HIgjFclDGLsbAFIodvSLjm9FbseasMELoxlAJDlwRnW8zo5sQmL0Fz7ao935QBynrng%3D%3D
|
||
```
|
||
|
||
**Step 3: Add signature to the request**
|
||
|
||
Complete the request by adding the `signature` parameter to the query string.
|
||
|
||
For the first set of example parameters (ASCII only):
|
||
|
||
```
|
||
curl -H "X-MBX-APIKEY: CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ" -X POST 'https://api.binance.com/api/v3/order?symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000&signature=HZ8HOjiJ1s%2FigS9JA%2Bn7%2B7Ti%2FihtkRF5BIWcPIEluJP6tlbFM%2FBf44LfZka%2FiemtahZAZzcO9TnI5uaXh3%2B%2BlrqtNonCwp6%2F245UFWkiW1elpgtVAmJPbogcAv6rSlokztAfWk296ZJXzRDYAtzGH0gq7CgSJKfH%2BXxaCmR0WcvlKjNQnp12%2FeKXJYO4tDap8UCBLuyxDnR7oJKLHQHJLP0r0EAVOOSIbrFang%2F1WOq%2BJaq4Efc4XpnTgnwlBbWTmhWDR1pvS9iVEzcSYLHT%2FfNnMRxFc7u%2Bj3qI%2F%2F5yuGuu14KR0MuQKKCSpViieD%2BfIti46sxPTsjSemoUKp0oXA%3D%3D'
|
||
```
|
||
|
||
For the second set of example parameters (some non-ASCII characters):
|
||
|
||
```
|
||
curl -H "X-MBX-APIKEY: CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ" -X POST 'https://api.binance.com/api/v3/order?symbol=%EF%BC%91%EF%BC%92%EF%BC%93%EF%BC%94%EF%BC%95%EF%BC%96&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000&signature=qJtv66wyp%2F1mZE%2BmIFAAMUoTe8xkmLN7%2FeAZjuC9x1ocxovItHLl%2FsNK7Wq8QjgiHqGn0bb8P7yVvGBEd1gFe71NQ8aM0M%2BJNIMz5UFxfeA53rXjFlvsyH1Sig%2BOuO9Nz5nhCaJ6bEfj2iuv7w27pB3L8MVqmoCi6D9C%2FQMiLxtPaR70CxtnvoOlIgPmpv2bQy029A31NEK19ieVLkoyp1EUkXRaX3v0mohx8yMnUG1dhX9nUg3Oy8TYZ03DQy7kHDGkMKisNX7rt%2FGuGx1HIgjFclDGLsbAFIodvSLjm9FbseasMELoxlAJDlwRnW8zo5sQmL0Fz7ao935QBynrng%3D%3D'
|
||
```
|
||
|
||
Here is a sample Bash script performing all the steps above:
|
||
|
||
```
|
||
function rawurlencode { local string="${1}" local strlen=${#string} local encoded="" local pos c o for (( pos=0 ; pos<strlen ; pos++ )); do c=${string:$pos:1} case "$c" in [-_.~a-zA-Z0-9] ) o="${c}" ;; * ) printf -v o '%%%02x' "'$c" esac encoded+="${o}" done echo "${encoded}"}API_KEY="put your own API Key here"PRIVATE_KEY_PATH="test-prv-key.pem"# Set up the request:API_METHOD="POST"API_CALL="api/v3/order"API_PARAMS="symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2"# Sign the request:timestamp=$(date +%s000)api_params_with_timestamp="$API_PARAMS×tamp=$timestamp"rawSignature=$(echo -n $api_params_with_timestamp | openssl dgst -keyform PEM -sha256 -sign $PRIVATE_KEY_PATH | openssl enc -base64 | tr -d '\n')# Percent-encode the signaturesignature=$(rawurlencode "$rawSignature")# Send the request:curl -H "X-MBX-APIKEY: $API_KEY" -X "$API_METHOD" \ "https://api.binance.com/$API_CALL?$api_params_with_timestamp" \ --data-urlencode "signature=$signature"
|
||
```
|
||
|
||
#### Ed25519 Keys[](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security)
|
||
|
||
**Note: It is highly recommended to use Ed25519 API keys as it should provide the best performance and security out of all supported key types.**
|
||
|
||
The signature payload of your request is the query string concatenated without separator to the HTTP body. Any non-ASCII character must be percent-encoded before signing.
|
||
|
||
There is one example with a symbol name comprised entirely of ASCII characters and one example with a symbol name containing non-ASCII characters.
|
||
|
||
These examples assume the private key is stored in the file `./test-prv-key.pem`.
|
||
|
||
Key
|
||
|
||
Value
|
||
|
||
`apiKey`
|
||
|
||
4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO
|
||
|
||
Example of request with a symbol name comprised entirely of ASCII characters.
|
||
|
||
Parameter
|
||
|
||
Value
|
||
|
||
`symbol`
|
||
|
||
BTCUSDT
|
||
|
||
`side`
|
||
|
||
SELL
|
||
|
||
`type`
|
||
|
||
LIMIT
|
||
|
||
`timeInForce`
|
||
|
||
GTC
|
||
|
||
`quantity`
|
||
|
||
1
|
||
|
||
`price`
|
||
|
||
0.2
|
||
|
||
`timestamp`
|
||
|
||
1668481559918
|
||
|
||
`recvWindow`
|
||
|
||
5000
|
||
|
||
Example of a request with a symbol name containing non-ASCII characters.
|
||
|
||
Parameter
|
||
|
||
Value
|
||
|
||
`symbol`
|
||
|
||
１２３４５６
|
||
|
||
`side`
|
||
|
||
SELL
|
||
|
||
`type`
|
||
|
||
LIMIT
|
||
|
||
`timeInForce`
|
||
|
||
GTC
|
||
|
||
`quantity`
|
||
|
||
1
|
||
|
||
`price`
|
||
|
||
0.2
|
||
|
||
`timestamp`
|
||
|
||
1668481559918
|
||
|
||
`recvWindow`
|
||
|
||
5000
|
||
|
||
**Step 1: Construct the signature payload**
|
||
|
||
1. Format parameters as `parameter=value` pairs separated by `&`.
|
||
2. Percent-encode the string.
|
||
|
||
For the first set of example parameters (ASCII only), the `parameter=value` string should look like this:
|
||
|
||
```
|
||
symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000
|
||
```
|
||
|
||
After percent-encoding, the signature payload should look like this:
|
||
|
||
```
|
||
symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000
|
||
```
|
||
|
||
For the second set of example parameters (some non-ASCII characters), the `parameter=value` string should look like this:
|
||
|
||
```
|
||
symbol=１２３４５６&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000
|
||
```
|
||
|
||
After percent-encoding, the signature payload should look like this:
|
||
|
||
```
|
||
symbol=%EF%BC%91%EF%BC%92%EF%BC%93%EF%BC%94%EF%BC%95%EF%BC%96&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000
|
||
```
|
||
|
||
**Step 2: Compute the signature**
|
||
|
||
1. Sign the payload.
|
||
2. Encode the output as a base64 string.
|
||
|
||
Note that the payload and the resulting `signature` are **case-sensitive**.
|
||
|
||
For the first set of example parameters (ASCII only):
|
||
|
||
```
|
||
echo -n "symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000" | openssl dgst -keyform PEM -sha256 -sign ./test-prv-key.pem | openssl enc -base64 | tr -d '\n'HaZnek7KOGa/k5+f6Q1nw8lzMUpo36mRVvvLHCMUCXxlmdQQGZge1luAUKnleD/DYeD19YrqzeHbb6xU3MkSIXKhAO1MaYq48uGVYb3vJScEZVOutgMInrZzUcCWNulNkfcbmExSiymCZ5xQBw5QDuzpuDFqRZ1Xt+BZxEHBN9OYQKpoe0+ovjnXyVOaH8VUKhE/ghUWnThrXJr+hmSc5t7ggjiVPQc7pGn3qSNGCQwdpkQC9GHMr/r+8n6qeEKMYB5j/1wC4d8Jae8FQiU8xcXR0NlUgV2LAw61/ZJv5BTJpa+z5Lv1W9v6jHQWRX2O8uaG3KU/lR3spR7+oGlWOw=
|
||
```
|
||
|
||
For the second set of example parameters (some non-ASCII characters):
|
||
|
||
```
|
||
echo -n "symbol=%EF%BC%91%EF%BC%92%EF%BC%93%EF%BC%94%EF%BC%95%EF%BC%96&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000" | openssl dgst -keyform PEM -sha256 -sign ./test-prv-key.pem | openssl enc -base64 | tr -d '\n'qJtv66wyp/1mZE+mIFAAMUoTe8xkmLN7/eAZjuC9x1ocxovItHLl/sNK7Wq8QjgiHqGn0bb8P7yVvGBEd1gFe71NQ8aM0M+JNIMz5UFxfeA53rXjFlvsyH1Sig+OuO9Nz5nhCaJ6bEfj2iuv7w27pB3L8MVqmoCi6D9C/QMiLxtPaR70CxtnvoOlIgPmpv2bQy029A31NEK19ieVLkoyp1EUkXRaX3v0mohx8yMnUG1dhX9nUg3Oy8TYZ03DQy7kHDGkMKisNX7rt/GuGx1HIgjFclDGLsbAFIodvSLjm9FbseasMELoxlAJDlwRnW8zo5sQmL0Fz7ao935QBynrng==
|
||
```
|
||
|
||
3. Percent-encode the base64 string.
|
||
|
||
For the first set of example parameters (ASCII only):
|
||
|
||
```
|
||
HaZnek7KOGa%2Fk5%2Bf6Q1nw8lzMUpo36mRVvvLHCMUCXxlmdQQGZge1luAUKnleD%2FDYeD19YrqzeHbb6xU3MkSIXKhAO1MaYq48uGVYb3vJScEZVOutgMInrZzUcCWNulNkfcbmExSiymCZ5xQBw5QDuzpuDFqRZ1Xt%2BBZxEHBN9OYQKpoe0%2BovjnXyVOaH8VUKhE%2FghUWnThrXJr%2BhmSc5t7ggjiVPQc7pGn3qSNGCQwdpkQC9GHMr%2Fr%2B8n6qeEKMYB5j%2F1wC4d8Jae8FQiU8xcXR0NlUgV2LAw61%2FZJv5BTJpa%2Bz5Lv1W9v6jHQWRX2O8uaG3KU%2FlR3spR7%2BoGlWOw%3D
|
||
```
|
||
|
||
For the second set of example parameters (some non-ASCII characters):
|
||
|
||
```
|
||
qJtv66wyp%2F1mZE%2BmIFAAMUoTe8xkmLN7%2FeAZjuC9x1ocxovItHLl%2FsNK7Wq8QjgiHqGn0bb8P7yVvGBEd1gFe71NQ8aM0M%2BJNIMz5UFxfeA53rXjFlvsyH1Sig%2BOuO9Nz5nhCaJ6bEfj2iuv7w27pB3L8MVqmoCi6D9C%2FQMiLxtPaR70CxtnvoOlIgPmpv2bQy029A31NEK19ieVLkoyp1EUkXRaX3v0mohx8yMnUG1dhX9nUg3Oy8TYZ03DQy7kHDGkMKisNX7rt%2FGuGx1HIgjFclDGLsbAFIodvSLjm9FbseasMELoxlAJDlwRnW8zo5sQmL0Fz7ao935QBynrng%3D%3D
|
||
```
|
||
|
||
**Step 3: Add signature to the request**
|
||
|
||
Complete the request by adding the `signature` parameter to the query string.
|
||
|
||
For the first set of example parameters (ASCII only):
|
||
|
||
```
|
||
curl -H "X-MBX-APIKEY: 4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO" -X POST 'https://api.binance.com/api/v3/order?symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000&signature=HaZnek7KOGa%2Fk5%2Bf6Q1nw8lzMUpo36mRVvvLHCMUCXxlmdQQGZge1luAUKnleD%2FDYeD19YrqzeHbb6xU3MkSIXKhAO1MaYq48uGVYb3vJScEZVOutgMInrZzUcCWNulNkfcbmExSiymCZ5xQBw5QDuzpuDFqRZ1Xt%2BBZxEHBN9OYQKpoe0%2BovjnXyVOaH8VUKhE%2FghUWnThrXJr%2BhmSc5t7ggjiVPQc7pGn3qSNGCQwdpkQC9GHMr%2Fr%2B8n6qeEKMYB5j%2F1wC4d8Jae8FQiU8xcXR0NlUgV2LAw61%2FZJv5BTJpa%2Bz5Lv1W9v6jHQWRX2O8uaG3KU%2FlR3spR7%2BoGlWOw%3D'
|
||
```
|
||
|
||
For the second set of example parameters (some non-ASCII characters):
|
||
|
||
```
|
||
curl -H "X-MBX-APIKEY: 4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO" -X POST 'https://api.binance.com/api/v3/order?symbol=%EF%BC%91%EF%BC%92%EF%BC%93%EF%BC%94%EF%BC%95%EF%BC%96&&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2×tamp=1668481559918&recvWindow=5000&signature=qJtv66wyp%2F1mZE%2BmIFAAMUoTe8xkmLN7%2FeAZjuC9x1ocxovItHLl%2FsNK7Wq8QjgiHqGn0bb8P7yVvGBEd1gFe71NQ8aM0M%2BJNIMz5UFxfeA53rXjFlvsyH1Sig%2BOuO9Nz5nhCaJ6bEfj2iuv7w27pB3L8MVqmoCi6D9C%2FQMiLxtPaR70CxtnvoOlIgPmpv2bQy029A31NEK19ieVLkoyp1EUkXRaX3v0mohx8yMnUG1dhX9nUg3Oy8TYZ03DQy7kHDGkMKisNX7rt%2FGuGx1HIgjFclDGLsbAFIodvSLjm9FbseasMELoxlAJDlwRnW8zo5sQmL0Fz7ao935QBynrng%3D%3D'
|
||
```
|
||
|
||
Here is a sample Python script performing all the steps above:
|
||
|
||
```
|
||
#!/usr/bin/env python3import base64import requestsimport timeimport urllib.parsefrom cryptography.hazmat.primitives.serialization import load_pem_private_key# Set up authenticationAPI_KEY='put your own API Key here'PRIVATE_KEY_PATH='test-prv-key.pem'# Load the private key.# In this example the key is expected to be stored without encryption,# but we recommend using a strong password for improved security.with open(PRIVATE_KEY_PATH, 'rb') as f: private_key = load_pem_private_key(data=f.read(), password=None)# Set up the request parametersparams = { 'symbol': 'BTCUSDT', 'side': 'SELL', 'type': 'LIMIT', 'timeInForce': 'GTC', 'quantity': '1.0000000', 'price': '0.20',}# Timestamp the requesttimestamp = int(time.time() * 1000) # UNIX timestamp in millisecondsparams['timestamp'] = timestamp# Sign the requestpayload = urllib.parse.urlencode(params, encoding='UTF-8')signature = base64.b64encode(private_key.sign(payload.encode('ASCII')))params['signature'] = signature# Send the requestheaders = { 'X-MBX-APIKEY': API_KEY,}response = requests.post( 'https://api.binance.com/api/v3/order', headers=headers, data=params,)print(response.json())
|
||
```
|
||
|
||
- [SIGNED Endpoint security](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security)
|
||
- [Timing security](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security)
|
||
- [SIGNED Endpoint Examples for POST /api/v3/order](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/request-security)
|