Place an order

Place an order

curl --request POST \
  --url https://api.example.com/api/orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "instrument_id": "598471892347",
  "firm_id": "298471892342",
  "side": "BUY",
  "price": "0.590",
  "quantity": "25.00",
  "time_in_force": "GTC",
  "client_order_id": "ord-100",
  "sub_account": "fund-a",
  "post_only": false,
  "post_only_reject": false,
  "self_match_prevention_id": 7,
  "self_match_prevention_mode": "CANCEL_RESTING"
}
'

import requests

url = "https://api.example.com/api/orders"

payload = {
    "instrument_id": "598471892347",
    "firm_id": "298471892342",
    "side": "BUY",
    "price": "0.590",
    "quantity": "25.00",
    "time_in_force": "GTC",
    "client_order_id": "ord-100",
    "sub_account": "fund-a",
    "post_only": False,
    "post_only_reject": False,
    "self_match_prevention_id": 7,
    "self_match_prevention_mode": "CANCEL_RESTING"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    instrument_id: '598471892347',
    firm_id: '298471892342',
    side: 'BUY',
    price: '0.590',
    quantity: '25.00',
    time_in_force: 'GTC',
    client_order_id: 'ord-100',
    sub_account: 'fund-a',
    post_only: false,
    post_only_reject: false,
    self_match_prevention_id: 7,
    self_match_prevention_mode: 'CANCEL_RESTING'
  })
};

fetch('https://api.example.com/api/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'instrument_id' => '598471892347',
    'firm_id' => '298471892342',
    'side' => 'BUY',
    'price' => '0.590',
    'quantity' => '25.00',
    'time_in_force' => 'GTC',
    'client_order_id' => 'ord-100',
    'sub_account' => 'fund-a',
    'post_only' => false,
    'post_only_reject' => false,
    'self_match_prevention_id' => 7,
    'self_match_prevention_mode' => 'CANCEL_RESTING'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/orders"

	payload := strings.NewReader("{\n  \"instrument_id\": \"598471892347\",\n  \"firm_id\": \"298471892342\",\n  \"side\": \"BUY\",\n  \"price\": \"0.590\",\n  \"quantity\": \"25.00\",\n  \"time_in_force\": \"GTC\",\n  \"client_order_id\": \"ord-100\",\n  \"sub_account\": \"fund-a\",\n  \"post_only\": false,\n  \"post_only_reject\": false,\n  \"self_match_prevention_id\": 7,\n  \"self_match_prevention_mode\": \"CANCEL_RESTING\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/orders")
  .header("Content-Type", "application/json")
  .body("{\n  \"instrument_id\": \"598471892347\",\n  \"firm_id\": \"298471892342\",\n  \"side\": \"BUY\",\n  \"price\": \"0.590\",\n  \"quantity\": \"25.00\",\n  \"time_in_force\": \"GTC\",\n  \"client_order_id\": \"ord-100\",\n  \"sub_account\": \"fund-a\",\n  \"post_only\": false,\n  \"post_only_reject\": false,\n  \"self_match_prevention_id\": 7,\n  \"self_match_prevention_mode\": \"CANCEL_RESTING\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instrument_id\": \"598471892347\",\n  \"firm_id\": \"298471892342\",\n  \"side\": \"BUY\",\n  \"price\": \"0.590\",\n  \"quantity\": \"25.00\",\n  \"time_in_force\": \"GTC\",\n  \"client_order_id\": \"ord-100\",\n  \"sub_account\": \"fund-a\",\n  \"post_only\": false,\n  \"post_only_reject\": false,\n  \"self_match_prevention_id\": 7,\n  \"self_match_prevention_mode\": \"CANCEL_RESTING\"\n}"

response = http.request(request)
puts response.read_body

{
  "order_id": "698471892348",
  "status": "PARTIALLY_FILLED",
  "instrument_id": "598471892347",
  "ticker": "NFL-GAMEWINNER-26NOV28LARSF-LAR",
  "side": "BUY",
  "original_side": "BUY",
  "price": "0.590000",
  "quantity": "25.00",
  "filled_quantity": "10.00",
  "remaining_quantity": "15.00",
  "time_in_force": "GTC",
  "client_order_id": "ord-100",
  "sub_account": "fund-a",
  "fills": [
    {
      "trade_id": "798471892349",
      "price": "0.590000",
      "quantity": "10.00",
      "fee": "0.170000",
      "role": "TAKER"
    }
  ],
  "reject_reason": "<string>"
}

{
  "error": "INVALID_FIELD",
  "message": "side must be one of: BUY, SELL, BUY_NO, SELL_NO"
}

POST

api

orders

Place an order

curl --request POST \
  --url https://api.example.com/api/orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "instrument_id": "598471892347",
  "firm_id": "298471892342",
  "side": "BUY",
  "price": "0.590",
  "quantity": "25.00",
  "time_in_force": "GTC",
  "client_order_id": "ord-100",
  "sub_account": "fund-a",
  "post_only": false,
  "post_only_reject": false,
  "self_match_prevention_id": 7,
  "self_match_prevention_mode": "CANCEL_RESTING"
}
'

import requests

url = "https://api.example.com/api/orders"

payload = {
    "instrument_id": "598471892347",
    "firm_id": "298471892342",
    "side": "BUY",
    "price": "0.590",
    "quantity": "25.00",
    "time_in_force": "GTC",
    "client_order_id": "ord-100",
    "sub_account": "fund-a",
    "post_only": False,
    "post_only_reject": False,
    "self_match_prevention_id": 7,
    "self_match_prevention_mode": "CANCEL_RESTING"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    instrument_id: '598471892347',
    firm_id: '298471892342',
    side: 'BUY',
    price: '0.590',
    quantity: '25.00',
    time_in_force: 'GTC',
    client_order_id: 'ord-100',
    sub_account: 'fund-a',
    post_only: false,
    post_only_reject: false,
    self_match_prevention_id: 7,
    self_match_prevention_mode: 'CANCEL_RESTING'
  })
};

fetch('https://api.example.com/api/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'instrument_id' => '598471892347',
    'firm_id' => '298471892342',
    'side' => 'BUY',
    'price' => '0.590',
    'quantity' => '25.00',
    'time_in_force' => 'GTC',
    'client_order_id' => 'ord-100',
    'sub_account' => 'fund-a',
    'post_only' => false,
    'post_only_reject' => false,
    'self_match_prevention_id' => 7,
    'self_match_prevention_mode' => 'CANCEL_RESTING'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/orders"

	payload := strings.NewReader("{\n  \"instrument_id\": \"598471892347\",\n  \"firm_id\": \"298471892342\",\n  \"side\": \"BUY\",\n  \"price\": \"0.590\",\n  \"quantity\": \"25.00\",\n  \"time_in_force\": \"GTC\",\n  \"client_order_id\": \"ord-100\",\n  \"sub_account\": \"fund-a\",\n  \"post_only\": false,\n  \"post_only_reject\": false,\n  \"self_match_prevention_id\": 7,\n  \"self_match_prevention_mode\": \"CANCEL_RESTING\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/orders")
  .header("Content-Type", "application/json")
  .body("{\n  \"instrument_id\": \"598471892347\",\n  \"firm_id\": \"298471892342\",\n  \"side\": \"BUY\",\n  \"price\": \"0.590\",\n  \"quantity\": \"25.00\",\n  \"time_in_force\": \"GTC\",\n  \"client_order_id\": \"ord-100\",\n  \"sub_account\": \"fund-a\",\n  \"post_only\": false,\n  \"post_only_reject\": false,\n  \"self_match_prevention_id\": 7,\n  \"self_match_prevention_mode\": \"CANCEL_RESTING\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instrument_id\": \"598471892347\",\n  \"firm_id\": \"298471892342\",\n  \"side\": \"BUY\",\n  \"price\": \"0.590\",\n  \"quantity\": \"25.00\",\n  \"time_in_force\": \"GTC\",\n  \"client_order_id\": \"ord-100\",\n  \"sub_account\": \"fund-a\",\n  \"post_only\": false,\n  \"post_only_reject\": false,\n  \"self_match_prevention_id\": 7,\n  \"self_match_prevention_mode\": \"CANCEL_RESTING\"\n}"

response = http.request(request)
puts response.read_body

{
  "order_id": "698471892348",
  "status": "PARTIALLY_FILLED",
  "instrument_id": "598471892347",
  "ticker": "NFL-GAMEWINNER-26NOV28LARSF-LAR",
  "side": "BUY",
  "original_side": "BUY",
  "price": "0.590000",
  "quantity": "25.00",
  "filled_quantity": "10.00",
  "remaining_quantity": "15.00",
  "time_in_force": "GTC",
  "client_order_id": "ord-100",
  "sub_account": "fund-a",
  "fills": [
    {
      "trade_id": "798471892349",
      "price": "0.590000",
      "quantity": "10.00",
      "fee": "0.170000",
      "role": "TAKER"
    }
  ],
  "reject_reason": "<string>"
}

{
  "error": "INVALID_FIELD",
  "message": "side must be one of: BUY, SELL, BUY_NO, SELL_NO"
}

Body

application/json

instrument_id

string

Id of the instrument to trade, as a canonical decimal string. Tickers and JSON numbers are rejected.

Example:

"598471892347"

firm_id

string | null

Id of the firm the order is for, as a canonical decimal string. Required for FCM-level API keys, and must be a firm under your FCM. A FIRM-level key may omit it or send its own firm id.

Example:

"298471892342"

side

string

Order side. BUY and SELL trade the YES contract. BUY_NO and SELL_NO trade the NO side and are booked as SELL or BUY of YES at one minus the price. BUY_NO and SELL_NO are REST only: FIX order entry accepts only Buy and Sell, so FIX clients convert NO orders themselves (BUY_NO at price P is SELL at 1 minus P).

Example:

"BUY"

price

string | null

Limit price per contract in USDC, as a decimal string strictly between 0 and 1 that aligns to the instrument's tick size. Omit or send null for a market order. For BUY_NO and SELL_NO it is the NO price and is required.

Example:

"0.590"

quantity

string

Number of contracts to trade, as a positive decimal string.

Example:

"25.00"

time_in_force

string

How long the order stays active: GTC rests until filled or canceled, IOC fills what it can immediately and cancels the rest, FOK fills completely at once or is rejected. Market orders run as IOC unless you send FOK.

Example:

"GTC"

client_order_id

string

Your identifier for the order: at most 18 printable ASCII characters, or a 36-character lowercase UUID. Must be unique among your active orders.

Example:

"ord-100"

sub_account

string

Sub-account the order and any resulting position belong to, in the same format as client_order_id. A new sub-account is created on first use.

Example:

"fund-a"

post_only

boolean | null

If true, the order only adds liquidity. An order that would cross the book rests at the best non-crossing price instead, unless post_only_reject is true. Not allowed on market orders.

Example:

false

post_only_reject

boolean | null

If true, the order only adds liquidity and is rejected with POST_ONLY_WOULD_CROSS if it would cross the book. Not allowed on market orders.

Example:

false

self_match_prevention_id

integer<int32> | null

Optional positive self-match prevention id. An incoming order does not match a resting order that carries the same id; self_match_prevention_mode decides which order is canceled.

Example:

7

self_match_prevention_mode

string | null

Which order to cancel when self-match prevention triggers: CANCEL_AGGRESSING, CANCEL_RESTING, or CANCEL_BOTH. When omitted, your user or firm default applies.

Example:

"CANCEL_RESTING"

Response

Order accepted. A 200 is returned only for accepted orders.

order_id

string

Exchange-assigned order id, as a canonical decimal string.

Example:

"698471892348"

status

string

Order state when the response was sent: SUBMITTED (resting with no fills), PARTIALLY_FILLED, FILLED, or CANCELED (nothing filled and the order was canceled, as with an unfilled IOC order).

Example:

"PARTIALLY_FILLED"

instrument_id

string

Instrument id, as a canonical decimal string.

Example:

"598471892347"

ticker

string

Instrument ticker.

Example:

"NFL-GAMEWINNER-26NOV28LARSF-LAR"

side

string

Side as booked: BUY or SELL of the YES contract. BUY_NO and SELL_NO orders appear here as SELL and BUY.

Example:

"BUY"

original_side

string

Side as you submitted it, including BUY_NO or SELL_NO.

Example:

"BUY"

price

string | null

Limit price of the YES order as booked, in USDC, as a decimal string. For BUY_NO and SELL_NO it is one minus the price you sent. Null for a market order.

Example:

"0.590000"

quantity

string

Order quantity in contracts, as a decimal string.

Example:

"25.00"

filled_quantity

string

Quantity filled by the time of the response, in contracts, as a decimal string.

Example:

"10.00"

remaining_quantity

string

Quantity not filled by the time of the response, in contracts, as a decimal string.

Example:

"15.00"

time_in_force

string

Time in force you submitted.

Example:

"GTC"

client_order_id

string

Echo of the client order id from the request.

Example:

"ord-100"

sub_account

string

Echo of the sub-account from the request.

Example:

"fund-a"

fills

object[] | null

Fills that executed before the response was sent, or null if there were none.

Show child attributes

reject_reason

string | null

Always null. A rejected order returns an error response instead of this object.

REST API Overview

REST Endpoints

FIX

WebSocket

Body

Response