Inclusion Preconf Trading

Authenticated endpoints for inclusion preconf order placement and management.

POST /v1/inclusion-preconf/order

Create new inclusion preconf order.

HTTP

curl -H "Authorization: Bearer {{access_token}}" -X POST "$ETHGAS_API_URL/v1/inclusion-preconf/order" \
  -H "Content-Type: application/json" \
  -d '{"instrumentId":"ETH-PC-9884031","accountId":128,"side":true,"orderType":2,"quantity":"10000","clientOrderId":"05d61624","passive":false,"price":"0.01"}'

Python

import requests

url = f"{ETHGAS_API_URL}/v1/inclusion-preconf/order"
payload = {
    "instrumentId": "ETH-PC-9884031",
    "accountId": 128,
    "side": True,
    "orderType": 2,
    "quantity": "10000",
    "clientOrderId": "05d61624",
    "passive": False,
    "price": "0.01"
}
headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <your-auth-token>'
}
response = requests.post(url, headers=headers, json=payload)
print(response.text)

Request Body

Parameter	Required	Type	Description
instrumentId	YES	string	Instrument ID
accountId	YES	integer	Account ID
side	YES	boolean	Order side (true = buy, false = sell)
orderType	YES	integer	Market = 1, Limit = 2, FOK = 3
quantity	YES	integer	Quantity to buy or sell
clientOrderId	YES	string	Client-generated order ID (max 32 chars)
passive	NO	boolean	Post-only (maker only) (default: false)
price	NO	double	Order price. Required for limit/FOK order

---

POST /v1/inclusion-preconf/cancel-all-orders

Cancel all inclusion preconf orders for an account and instrument.

HTTP

curl -H "Authorization: Bearer {{access_token}}" -X POST "$ETHGAS_API_URL/v1/inclusion-preconf/cancel-all-orders?accountId=128&instrumentId=ETH-PC-1012051"

Python

import requests

url = f"{ETHGAS_API_URL}/v1/inclusion-preconf/cancel-all-orders"
params = {"accountId": 128, "instrumentId": "ETH-PC-1012051"}
headers = {'Authorization': 'Bearer <your-auth-token>'}
response = requests.post(url, headers=headers, params=params)
print(response.text)

Request

Parameter	Required	Type	Description
accountId	YES	integer	Account ID
instrumentId	YES	string	Instrument ID

---

POST /v1/inclusion-preconf/cancel-batch-orders

Cancel specific inclusion preconf orders.

HTTP

curl -H "Authorization: Bearer {{access_token}}" -X POST "$ETHGAS_API_URL/v1/inclusion-preconf/cancel-batch-orders?accountId=128&instrumentId=ETH-PC-1012051&orderIds=b25ab402,5e885ddd"

Python

import requests

url = f"{ETHGAS_API_URL}/v1/inclusion-preconf/cancel-batch-orders"
params = {
    "accountId": 128,
    "instrumentId": "ETH-PC-1012051",
    "orderIds": "b25ab402,5e885ddd"
}
headers = {'Authorization': 'Bearer <your-auth-token>'}
response = requests.post(url, headers=headers, params=params)
print(response.text)

Request

Parameter	Required	Type	Description
accountId	YES	integer	Account ID
instrumentId	YES	string	Instrument ID
orderIds	YES	string	Comma-separated order IDs

---

POST /v1/inclusion-preconf/cancel-order

Cancel a single inclusion preconf order.

HTTP

curl -H "Authorization: Bearer {{access_token}}" -X POST "$ETHGAS_API_URL/v1/inclusion-preconf/cancel-order" \
  -H "Content-Type: application/json" \
  -d '{"accountId":128,"instrumentId":"ETH-PC-1012051","orderId":"b25ab402"}'

Python

import requests

url = f"{ETHGAS_API_URL}/v1/inclusion-preconf/cancel-order"
payload = {
    "accountId": 128,
    "instrumentId": "ETH-PC-1012051",
    "orderId": "b25ab402"
}
headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <your-auth-token>'
}
response = requests.post(url, headers=headers, json=payload)
print(response.text)

Request

Parameter	Required	Type	Description
accountId	YES	integer	Account ID
instrumentId	YES	string	Instrument ID
orderId	YES*	integer	Order ID (use orderId or clientOrderId)
clientOrderId	YES*	string	Client order ID (use orderId or clientOrderId)

---

GET /v1/user/inclusion-preconf/orders

Get user inclusion preconf orders for an account and instrument.

HTTP

curl -H "Authorization: Bearer {{access_token}}" -X GET "$ETHGAS_API_URL/v1/user/inclusion-preconf/orders?accountId=128&instrumentId=ETH-PC-9884031"

Python

import requests

url = f"{ETHGAS_API_URL}/v1/user/inclusion-preconf/orders"
params = {"accountId": 128, "instrumentId": "ETH-PC-9884031"}
headers = {'Authorization': 'Bearer <your-auth-token>'}
response = requests.get(url, headers=headers, params=params)
print(response.text)

Request

Parameter	Required	Type	Description
accountId	YES	integer	Account ID
instrumentId	NO	string	Instrument ID
onBook	NO	boolean	Pending orders only
done	NO	boolean	Done orders only
startId	NO	integer	Start of order ID for pagination
limit	NO	integer	Max orders to return

---

GET /v1/user/inclusion-preconf/all-orders

Get all user inclusion preconf orders.

HTTP

curl -H "Authorization: Bearer {{access_token}}" -X GET "$ETHGAS_API_URL/v1/user/inclusion-preconf/all-orders?limit=10"

Python

import requests

url = f"{ETHGAS_API_URL}/v1/user/inclusion-preconf/all-orders"
params = {"limit": 10}
headers = {'Authorization': 'Bearer <your-auth-token>'}
response = requests.get(url, headers=headers, params=params)
print(response.text)

---

GET /v1/user/inclusion-preconf/positions

Get user inclusion preconf positions.

HTTP

curl -H "Authorization: Bearer {{access_token}}" -X GET "$ETHGAS_API_URL/v1/user/inclusion-preconf/positions?instrumentId=ETH-PC-9884031&limit=10"

Python

import requests

url = f"{ETHGAS_API_URL}/v1/user/inclusion-preconf/positions"
params = {"instrumentId": "ETH-PC-9884031", "limit": 10}
headers = {'Authorization': 'Bearer <your-auth-token>'}
response = requests.get(url, headers=headers, params=params)
print(response.text)

---

GET /v1/user/inclusion-preconf/txs

Get user transactions for inclusion preconf market.

HTTP

curl -H "Authorization: Bearer {{access_token}}" -X GET "$ETHGAS_API_URL/v1/user/inclusion-preconf/txs?instrumentId=ETH-PC-9884031&limit=100"

Python

import requests

url = f"{ETHGAS_API_URL}/v1/user/inclusion-preconf/txs"
params = {"instrumentId": "ETH-PC-9884031", "limit": 100}
headers = {'Authorization': 'Bearer <your-auth-token>'}
response = requests.get(url, headers=headers, params=params)
print(response.text)

---

POST /v1/user/inclusion-preconf/market/update

Block owner reserve inclusion preconf.

HTTP

curl -H "Authorization: Bearer {{access_token}}" -X POST "$ETHGAS_API_URL/v1/user/inclusion-preconf/market/update?instrumentId=ETH-PC-475423&reservedQty=1000"

Python

import requests

url = f"{ETHGAS_API_URL}/v1/user/inclusion-preconf/market/update"
params = {'instrumentId': 'ETH-PC-475423', 'reservedQty': 1000}
headers = {'Authorization': 'Bearer <your-auth-token>'}
response = requests.post(url, headers=headers, params=params)
print(response.text)

Request

Parameter	Required	Type	Description
instrumentId	YES	string	Instrument ID
reservedQty	YES	integer	Reserved quantity