New Order V3

Send in a new order using Web3 authentication.

POST /v1/aster/fapi/v3/order

New Order V3

cURL

curl --request POST \
  --url https://api.hypereth.io/v1/aster/fapi/v3/order \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'symbol=<string>' \
  --data timestamp=123 \
  --data 'user=<string>' \
  --data 'signer=<string>' \
  --data 'nonce=<string>' \
  --data 'signature=<string>' \
  --data positionSide=BOTH \
  --data 'quantity=<string>' \
  --data 'price=<string>' \
  --data 'newClientOrderId=<string>' \
  --data 'stopPrice=<string>' \
  --data 'activationPrice=<string>' \
  --data 'callbackRate=<string>' \
  --data recvWindow=123

200

{
  "clientOrderId": "<string>",
  "cumQty": "<string>",
  "cumQuote": "<string>",
  "executedQty": "<string>",
  "orderId": 123,
  "avgPrice": "<string>",
  "origQty": "<string>",
  "price": "<string>",
  "reduceOnly": true,
  "side": "<string>",
  "positionSide": "<string>",
  "status": "<string>",
  "stopPrice": "<string>",
  "closePosition": true,
  "symbol": "<string>",
  "timeInForce": "<string>",
  "type": "<string>",
  "origType": "<string>",
  "activatePrice": "<string>",
  "priceRate": "<string>",
  "updateTime": 123,
  "workingType": "<string>",
  "priceProtect": true
}

Authorizations

Authorization · string · header · required

Web3 authentication using user, signer, nonce, and signature parameters

Body

application/x-www-form-urlencoded

symbol · string · required

side · enum<string> · required

Available options: BUY, SELL

type · enum<string> · required

Available options: LIMIT, MARKET, STOP, TAKE_PROFIT, STOP_MARKET, TAKE_PROFIT_MARKET, TRAILING_STOP_MARKET

timestamp · integer<int64> · required

user · string · required

Ethereum address

Pattern: ^0x[a-fA-F0-9]{40}$

signer · string · required

Signer Ethereum address

Pattern: ^0x[a-fA-F0-9]{40}$

nonce · string · required

Microsecond timestamp

signature · string · required

Ethereum signature

Pattern: ^0x[a-fA-F0-9]{130}$

positionSide · enum<string> · default: BOTH

Available options: BOTH, LONG, SHORT

timeInForce · enum<string>

Available options: GTC, IOC, FOK, GTX

quantity · string

reduceOnly · enum<string>

Available options: true, false

price · string

newClientOrderId · string

stopPrice · string

closePosition · enum<string>

Available options: true, false

activationPrice · string

callbackRate · string

workingType · enum<string>

Available options: MARK_PRICE, CONTRACT_PRICE

priceProtect · enum<string>

Available options: true, false

newOrderRespType · enum<string>

Available options: ACK, RESULT

recvWindow · integer<int64>

Response

200 - application/json

Order placed successfully

clientOrderId · string

cumQty · string

cumQuote · string

executedQty · string

orderId · integer<int64>

avgPrice · string

origQty · string

price · string

reduceOnly · boolean

side · string

positionSide · string

status · string

stopPrice · string

closePosition · boolean

symbol · string

timeInForce · string

type · string

origType · string

activatePrice · string

priceRate · string

updateTime · integer<int64>

workingType · string

priceProtect · boolean