philipid3s / binance-trading-api Goto Github PK

REST API for interacting with the Binance trading platform

1. Create account on the Binance Spot Test Network: https://testnet.binance.vision/
2. Generate API keys

3. Create account on the Binance Futures Test Network: https://testnet.binancefuture.com/
4. Copy API keys from API Keys tab

5. Rename config-sample.js to config.js and input the API keys

npm install

npm start

URL: /order

Method: GET

Query Parameters:

• user (required): User identifier
• symbol (required): Trading pair symbol (e.g., BTCUSDT)
• side (required): Order side (BUY or SELL)
• quantity (required): Order quantity
• market (optional): Market type (spot or futures, default is spot)
• environment (optional): Environment type (testnet or live, default is testnet)

Response:

• JSON object containing the order response

Example:

curl "http://localhost:3000/order?user=user1&symbol=BTCUSDT&side=BUY&quantity=0.01"

URL: /account

Method: GET

Query Parameters:

• user (required): User identifier
• market (optional): Market type (spot or futures, default is spot)
• environment (optional): Environment type (testnet or live, default is testnet)

Response:

• JSON object containing the account data

Example:

curl "http://localhost:3000/account?user=user1"

URL: /balance

Method: GET

Query Parameters:

• user (required): User identifier
• symbol (required): Asset symbol (e.g., BTC)
• market (optional): Market type (spot or futures, default is spot)
• environment (optional): Environment type (testnet or live, default is testnet)

Response:

• JSON object containing the asset balance

Example:

curl "http://localhost:3000/balance?user=user1&symbol=BTC"

URL: /price

Method: GET

Query Parameters:

• user (required): User identifier
• symbol (required): Trading pair symbol (e.g., BTCUSDT)
• market (optional): Market type (spot or futures, default is spot)
• environment (optional): Environment type (testnet or live, default is testnet)

Response:

• JSON object containing the ticker price

Example:

curl "http://localhost:3000/balance?user=user1&symbol=BTC"

URL: /historical-price

Fetch a single price at a specific datetime.

Method: GET

Query Parameters:

• user (required): User identifier.
• symbol (required): Trading pair symbol (e.g., BTCUSDT).
• datetime (required): The specific datetime in YYYYMMDDHHmm format.
• interval (optional): Data interval (1m, 5m, 15m, 30m, 1h, 4h, 1d, default is 1h).
• market (optional): Market type (spot or futures, default is spot).
• environment (optional): Environment type (testnet or live, default is live).

Example:

GET /historical-price?user=testUser&symbol=BTCUSDT&datetime=202401020000&interval=1h

URL: /historical-price-range

Fetch historical price data for a specific trading pair over a time range.

Method: GET

Query Parameters:

• user (required): User identifier.
• symbol (required): Trading pair symbol (e.g., BTCUSDT).
• startTime (required): Start time in YYYYMMDDHHmm format.
• endTime (required): End time in YYYYMMDDHHmm format.
• interval (optional): Data interval (1m, 5m, 15m, 30m, 1h, 4h, 1d, default is 1h).
• market (optional): Market type (spot or futures, default is spot).
• environment (optional): Environment type (testnet or live, default is live). |

Example:

GET /historical-price-range?user=yourBinanceUser&symbol=BTCUSDT&startTime=202401010000&endTime=202401020000&interval=1h&market=spot&environment=live