import { createClient } from "@parlayx/sdk";
const client = createClient({ apiKey: process.env.PARLAYX_API_KEY! });
const order = await client.getOrder("3f8b2c9a-2d18-4f7e-9c2a-1b6e1f0c8a4d");
console.log(order.status, order.filledAmount, order.executionCost);
for (const result of order.marketOrders) {
console.log(result.type, result.status, result.filledAmount);
}curl --request GET \
--url https://api.parlayx.com/v1/orders/{orderId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.parlayx.com/v1/orders/{orderId}"
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/{orderId}', 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/{orderId}",
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/{orderId}"
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/{orderId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parlayx.com/v1/orders/{orderId}")
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{
"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>"
}{
"error": {
"message": "<string>"
}
}{
"message": "Forbidden"
}{
"error": {
"message": "<string>"
}
}Get Order
Fetches an order by its issued orderId.
import { createClient } from "@parlayx/sdk";
const client = createClient({ apiKey: process.env.PARLAYX_API_KEY! });
const order = await client.getOrder("3f8b2c9a-2d18-4f7e-9c2a-1b6e1f0c8a4d");
console.log(order.status, order.filledAmount, order.executionCost);
for (const result of order.marketOrders) {
console.log(result.type, result.status, result.filledAmount);
}curl --request GET \
--url https://api.parlayx.com/v1/orders/{orderId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.parlayx.com/v1/orders/{orderId}"
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/{orderId}', 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/{orderId}",
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/{orderId}"
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/{orderId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parlayx.com/v1/orders/{orderId}")
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{
"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>"
}{
"error": {
"message": "<string>"
}
}{
"message": "Forbidden"
}{
"error": {
"message": "<string>"
}
}Authorizations
Path Parameters
Issued orderId.
1"3f8b2c9a-2d18-4f7e-9c2a-1b6e1f0c8a4d"
Response
Order found
Issued orderId.
1"3f8b2c9a-2d18-4f7e-9c2a-1b6e1f0c8a4d"
Order 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.
pending, open, partial, filled, cancelled, failed "open"
Total amount filled across all market orders, in USDC.
All-in cost to execute this order, in USDC: venue fees plus collateral conversion slippage. Excludes gas (covered by ParlayX) and recoverable leftover collateral.
Each market order in this order, in the order submitted — a type-discriminated entry (market/limit/stop/stop_limit). A conditional (stop/stop_limit) rests nothing until it fires, then this entry reflects the fills of the order it placed.
- MarketOrderResult
- LimitOrderResult
- StopOrderResult
- StopLimitOrderResult
- IcebergOrderResult
Show child attributes
Show child attributes
ISO-8601 time the order was created.
ISO-8601 time the order was last updated.