Pular para o conteúdo principal
POST
/
trade
/
order
Place Order
curl --request POST \
  --url https://data-api.voxfi.com.br/v1/trade/order \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "event_id": "08e1fcc2-6c1d-41f7-aec4-f2aa4d83cd48",
  "market_id": "08e1fcc2-6c1d-41f7-aec4-f2aa4d83cd48",
  "order_type": "LIMIT_BUY",
  "outcome": "YES",
  "price_ticks": 27,
  "quantity": 100,
  "value_cents": 10000
}
'
{
  "message": "<string>",
  "received": 123,
  "resting_order_id": "<string>",
  "spent": 123,
  "success": true,
  "trades": [
    {
      "maker_user_id": "<string>",
      "outcome": "<string>",
      "price_ticks": 123,
      "quantity": 123,
      "trade_id": "<string>"
    }
  ]
}

Cabeçalhos

x-api-key
string
obrigatório

API Key

Corpo

application/json

Place Order Input

event_id
string
obrigatório
Exemplo:

"08e1fcc2-6c1d-41f7-aec4-f2aa4d83cd48"

market_id
string
obrigatório
Exemplo:

"08e1fcc2-6c1d-41f7-aec4-f2aa4d83cd48"

order_type
string
obrigatório

"LIMIT", "LIMIT_BUY", "LIMIT_SELL", "MARKET_BUY_VALUE", "MARKET_BUY_QTY", "MARKET_SELL"

Exemplo:

"LIMIT_BUY"

outcome
string
obrigatório

"YES" or "NO"

Exemplo:

"YES"

price_ticks
integer

price in ticks (0-100) - For LIMIT orders (optional when using LIMIT_BUY or LIMIT_SELL)

Exemplo:

27

quantity
integer

number of contracts - For quantity-based orders (LIMIT_BUY, LIMIT_SELL, MARKET_BUY_QTY, MARKET_SELL)

Exemplo:

100

value_cents
integer

maximum value to spend in cents - For MARKET_BUY_VALUE

Exemplo:

10000

Resposta

OK

message
string
received
integer

For market sell orders

resting_order_id
string

For limit orders

spent
integer

For market buy orders

success
boolean
trades
object[]