TypeScript SDK
import { createClient } from "@parlayx/sdk";
const client = createClient({ apiKey: process.env.PARLAYX_API_KEY! });
const { orders } = await client.listOrders({ status: ["open", "partial"], pageSize: 50 });
for (const order of orders) {
console.log(order.orderId, order.status, order.filledAmount);
}curl --request GET \
--url https://api.parlayx.com/v1/orders \
--header 'x-api-key: <api-key>'import requests
url = "https://api.parlayx.com/v1/orders"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.parlayx.com/v1/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.parlayx.com/v1/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.parlayx.com/v1/orders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.parlayx.com/v1/orders")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parlayx.com/v1/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"orders": [
{
"orderId": "3f8b2c9a-2d18-4f7e-9c2a-1b6e1f0c8a4d",
"status": "open",
"filledAmount": 123,
"executionCost": 123,
"marketOrders": [
{
"type": "market",
"marketInfo": {
"venue": "polymarket",
"outcomeId": "<string>"
},
"status": "open",
"filledAmount": 123,
"averagePrice": 0.5,
"executionCost": 123,
"error": {
"message": "<string>"
}
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextPageToken": "<string>"
}{
"error": {
"message": "<string>"
}
}{
"message": "Forbidden"
}{
"error": {
"message": "<string>"
}
}Orders
List Orders
Returns a paginated list of orders.
GET
/
v1
/
orders
TypeScript SDK
import { createClient } from "@parlayx/sdk";
const client = createClient({ apiKey: process.env.PARLAYX_API_KEY! });
const { orders } = await client.listOrders({ status: ["open", "partial"], pageSize: 50 });
for (const order of orders) {
console.log(order.orderId, order.status, order.filledAmount);
}curl --request GET \
--url https://api.parlayx.com/v1/orders \
--header 'x-api-key: <api-key>'import requests
url = "https://api.parlayx.com/v1/orders"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.parlayx.com/v1/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.parlayx.com/v1/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.parlayx.com/v1/orders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.parlayx.com/v1/orders")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parlayx.com/v1/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"orders": [
{
"orderId": "3f8b2c9a-2d18-4f7e-9c2a-1b6e1f0c8a4d",
"status": "open",
"filledAmount": 123,
"executionCost": 123,
"marketOrders": [
{
"type": "market",
"marketInfo": {
"venue": "polymarket",
"outcomeId": "<string>"
},
"status": "open",
"filledAmount": 123,
"averagePrice": 0.5,
"executionCost": 123,
"error": {
"message": "<string>"
}
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextPageToken": "<string>"
}{
"error": {
"message": "<string>"
}
}{
"message": "Forbidden"
}{
"error": {
"message": "<string>"
}
}Authorizations
Query Parameters
Max results to return (1-100). Applies to the first page only; ignored when a pageToken is supplied (the token's encoded page size wins).
Required range:
1 <= x <= 100Example:
20
Opaque cursor from a previous response's nextPageToken. Encodes the page size so it does not need to be re-sent. Omit to fetch the first page.
Minimum string length:
1Filter to specific order statuses (comma-separated). Omit to return all.
Minimum array length:
1Order lifecycle. pending: accepted; funding/signing, not yet resting. open: resting on the book, no fills yet. partial: partially filled. filled: fully filled. cancelled / failed: terminal.
Available options:
pending, open, partial, filled, cancelled, failed Example:
["open", "filled"]
Filter to specific order types (comma-separated: market, limit, stop, stop_limit). Omit to return all.
Minimum array length:
1Available options:
market, limit, stop, stop_limit, iceberg Example:
["stop_limit"]
⌘I