API Reference
Market Data
Advanced
Get Markets
curl --request GET \
--url https://api.example.com/v1/markets{
"success": true,
"data": [
{
"id": "<string>",
"event_id": "<string>",
"platform": "<string>",
"token_id": "<string>",
"ticker": "<string>",
"outcome": "<string>",
"price": 123,
"best_bid": 123,
"best_ask": 123,
"spread": 123,
"volume": 123,
"volume_24h": 123,
"liquidity": 123,
"last_updated": "<string>"
}
]
}Market Data
Get Markets
Fetch individual prediction markets
GET
/
v1
/
markets
Get Markets
curl --request GET \
--url https://api.example.com/v1/markets{
"success": true,
"data": [
{
"id": "<string>",
"event_id": "<string>",
"platform": "<string>",
"token_id": "<string>",
"ticker": "<string>",
"outcome": "<string>",
"price": 123,
"best_bid": 123,
"best_ask": 123,
"spread": 123,
"volume": 123,
"volume_24h": 123,
"liquidity": 123,
"last_updated": "<string>"
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.matchr.xyz/llms.txt
Use this file to discover all available pages before exploring further.
Get Markets
Retrieve individual markets (outcomes) within events. Markets represent tradable outcomes like “Yes” or “No”.Endpoint
GET https://api.matchr.xyz/v1/markets
Query Parameters
Number of results to return (max: 200)
Pagination offset
Filter markets by parent event ID
Filter by platform:
polymarket, kalshi, or allMinimum total volume in USD
Minimum available liquidity in USD
Filter by outcome type:
yes, no, or allExample Request
curl -X GET "https://api.matchr.xyz/v1/markets?event_id=evt_123&limit=10" \
-H "Authorization: Bearer YOUR_API_KEY"
Response
Whether the request succeeded
Array of market objects
Show Market Object
Show Market Object
Unique market identifier
Parent event identifier
Source platform (polymarket, kalshi)
Platform-specific token identifier (Polymarket only)
Market ticker symbol (Kalshi only)
Outcome label (e.g., “Yes”, “No”, “Trump”, “Biden”)
Current price (0.00 - 1.00)
Highest bid price
Lowest ask price
Bid-ask spread
Total trading volume (USD)
24-hour trading volume (USD)
Available liquidity at current price
ISO 8601 timestamp of last price update
Example Response
{
"success": true,
"data": [
{
"id": "mkt_yes123",
"event_id": "evt_123abc",
"platform": "polymarket",
"token_id": "21742633143463906290569050155826241533067272736897614950488156847949938836455",
"outcome": "Yes",
"price": 0.52,
"best_bid": 0.51,
"best_ask": 0.53,
"spread": 0.02,
"volume": 8500000,
"volume_24h": 250000,
"liquidity": 150000,
"last_updated": "2024-10-15T14:30:00Z"
},
{
"id": "mkt_no123",
"event_id": "evt_123abc",
"platform": "polymarket",
"token_id": "48331043336612883890938759509493159234755048973500640163166885851047098274915",
"outcome": "No",
"price": 0.48,
"best_bid": 0.47,
"best_ask": 0.49,
"spread": 0.02,
"volume": 7500000,
"volume_24h": 200000,
"liquidity": 120000,
"last_updated": "2024-10-15T14:30:00Z"
}
],
"meta": {
"page": 1,
"limit": 10,
"total": 2
}
}
Get Single Market
Retrieve a specific market by ID.GET https://api.matchr.xyz/v1/markets/{market_id}
curl -X GET "https://api.matchr.xyz/v1/markets/mkt_yes123" \
-H "Authorization: Bearer YOUR_API_KEY"
Market Orderbook
Get the full orderbook for a market.GET https://api.matchr.xyz/v1/markets/{market_id}/orderbook
Query Parameters
Number of price levels to return
Response
{
"success": true,
"data": {
"market_id": "mkt_yes123",
"timestamp": "2024-10-15T14:30:00Z",
"bids": [
{ "price": 0.51, "size": 5000 },
{ "price": 0.50, "size": 12000 },
{ "price": 0.49, "size": 8000 }
],
"asks": [
{ "price": 0.53, "size": 4000 },
{ "price": 0.54, "size": 9000 },
{ "price": 0.55, "size": 15000 }
]
}
}
Error Codes
| Code | Description |
|---|---|
400 | Invalid query parameters |
401 | Missing or invalid API key |
404 | Market not found |
429 | Rate limit exceeded |
500 | Server error |
⌘I