REST APIOrders

Get order match events

GET
/orders/matches

Get a paginated list of order match events with optional filtering. Results are sorted by executedAt DESC. The executedAfter and executedBefore filters are unix timestamps in milliseconds and both bounds are exclusive. The orderHashes filter accepts up to 25 order hashes, comma separated or repeated, and returns the match events in which any of those orders took part as maker or taker. Hashes that do not belong to any order are ignored. A match event describes a whole transaction, so filtering by a maker order also includes the other fills settled in the same transaction.

Authorization

ApiKeyAuth
headerx-api-key<token>

API key authentication via the x-api-key header.

Query Parameters

first?integer

Page size, from 1 to 150. Defaults to 50. A value outside that range is clamped.

Formatint32
after?string

The cursor from the previous page, to get the next one.

categoryId?string

Only matches in the category with this slug, which markets return as categorySlug.

marketId?integer

Only matches in this market.

Formatint64
minValueUsdtWei?string

Only matches with at least one fill worth this much or more, in wei, where 1 USDT is 10^18 units.

signerAddress?string

Only matches in which this address was the maker or the taker. For a Predict account, use the account's address.

isSignerMaker?boolean

Set to true for only the matches where signerAddress was the maker, or false for those where it was the taker. Requires signerAddress.

orderHashes?array<string>

Only matches in which one of these orders was the maker or the taker. Takes up to 25 hashes, comma-separated or repeated.

executedAfter?integer

Only include matches executed strictly after this unix timestamp (milliseconds).

Formatint64
executedBefore?integer

Only include matches executed strictly before this unix timestamp (milliseconds).

Formatint64

Response Body

application/json; charset=utf-8
  1. response

Response for GET /v1/orders/matches

success*boolean
cursor?string
data*array<>
Example Request
curl -X GET 'https://api.predict.fun/v1/orders/matches'
Example Response
{  "success": true,  "cursor": "string",  "data": [    {      "market": {        "id": 0,        "imageUrl": "string",        "title": "string",        "question": "string",        "description": "string",        "tradingStatus": "OPEN",        "status": "REGISTERED",        "isVisible": true,        "isNegRisk": true,        "isYieldBearing": true,        "feeRateBps": 0,        "makerFeeBps": 0,        "resolution": {          "name": "string",          "indexSet": 0,          "onChainId": "string",          "status": "WON",          "bestBid": {            "price": 0.1,            "size": 0.1          },          "bestAsk": {            "price": 0.1,            "size": 0.1          },          "team": {            "id": 0,            "name": "string",            "abbreviation": "string",            "alias": "string",            "league": "string"          },          "variantData": {            "type": "ESPORTS_DOTA2",            "provider": "PREDICT_SPORTS",            "team": {              "id": 0,              "name": "string",              "abbreviation": "string",              "providerTeamId": "string",              "isHome": true,              "record": {                "wins": 0,                "losses": 0,                "draws": 0,                "overtimeLosses": 0              },              "color": "string"            }          },          "variantDetails": {            "sports": {              "provider": "PREDICT_SPORTS",              "team": {                "id": 0,                "name": "string",                "abbreviation": "string",                "providerTeamId": "string",                "isHome": true,                "record": {                  "wins": 0,                  "losses": 0,                  "draws": 0,                  "overtimeLosses": 0                },                "color": "string"              }            }          }        },        "oracleQuestionId": "string",        "conditionId": "string",        "resolverAddress": "string",        "outcomes": [          {            "name": "string",            "indexSet": 0,            "onChainId": "string",            "status": "WON",            "bestBid": {              "price": 0.1,              "size": 0.1            },            "bestAsk": {              "price": 0.1,              "size": 0.1            },            "team": {              "id": 0,              "name": "string",              "abbreviation": "string",              "alias": "string",              "league": "string"            },            "variantData": {              "type": "ESPORTS_DOTA2",              "provider": "PREDICT_SPORTS",              "team": {                "id": 0,                "name": "string",                "abbreviation": "string",                "providerTeamId": "string",                "isHome": true,                "record": {                  "wins": 0,                  "losses": 0,                  "draws": 0,                  "overtimeLosses": 0                },                "color": "string"              }            },            "variantDetails": {              "sports": {                "provider": "PREDICT_SPORTS",                "team": {                  "id": 0,                  "name": "string",                  "abbreviation": "string",                  "providerTeamId": "string",                  "isHome": true,                  "record": {                    "wins": 0,                    "losses": 0,                    "draws": 0,                    "overtimeLosses": 0                  },                  "color": "string"                }              }            }          }        ],        "questionIndex": 0,        "spreadThreshold": 0.1,        "shareThreshold": 0,        "isBoosted": true,        "boostStartsAt": "string",        "boostEndsAt": "string",        "polymarketConditionIds": [          "string"        ],        "kalshiMarketTicker": "string",        "categorySlug": "string",        "seriesSlug": "string",        "createdAt": "string",        "decimalPrecision": 0,        "marketVariant": "DEFAULT",        "variantData": {          "type": "CRYPTO_UP_DOWN",          "priceFeedProvider": "PYTH",          "startPrice": 0.1,          "endPrice": 0.1,          "priceFeedId": "string",          "priceFeedSymbol": "string"        },        "variantDetails": {          "sports": {            "provider": "PREDICT_SPORTS",            "team": {              "id": 0,              "name": "string",              "abbreviation": "string",              "providerTeamId": "string",              "isHome": true,              "record": {                "wins": 0,                "losses": 0,                "draws": 0,                "overtimeLosses": 0              },              "color": "string"            },            "line": 0.1,            "gameNumber": 0          }        },        "team": {          "id": 0,          "name": "string",          "abbreviation": "string",          "alias": "string",          "league": "string"        },        "marketType": "SPORTS_MONEYLINE",        "rewards": {          "current": {            "hourlyRate": 0,            "startsAt": "string",            "endsAt": "string"          },          "schedule": [            {              "hourlyRate": 0,              "startsAt": "string",              "endsAt": "string"            }          ]        }      },      "taker": {        "quoteType": "Ask",        "amount": "string",        "price": "string",        "outcome": {          "name": "string",          "indexSet": 0,          "onChainId": "string",          "status": "WON",          "bestBid": {            "price": 0.1,            "size": 0.1          },          "bestAsk": {            "price": 0.1,            "size": 0.1          },          "team": {            "id": 0,            "name": "string",            "abbreviation": "string",            "alias": "string",            "league": "string"          },          "variantData": {            "type": "ESPORTS_DOTA2",            "provider": "PREDICT_SPORTS",            "team": {              "id": 0,              "name": "string",              "abbreviation": "string",              "providerTeamId": "string",              "isHome": true,              "record": {                "wins": 0,                "losses": 0,                "draws": 0,                "overtimeLosses": 0              },              "color": "string"            }          },          "variantDetails": {            "sports": {              "provider": "PREDICT_SPORTS",              "team": {                "id": 0,                "name": "string",                "abbreviation": "string",                "providerTeamId": "string",                "isHome": true,                "record": {                  "wins": 0,                  "losses": 0,                  "draws": 0,                  "overtimeLosses": 0                },                "color": "string"              }            }          }        },        "signer": "string",        "hash": "string",        "fee": {          "amount": "string",          "type": "COLLATERAL"        }      },      "amountFilled": "string",      "priceExecuted": "string",      "makers": [        {          "quoteType": "Ask",          "amount": "string",          "price": "string",          "outcome": {            "name": "string",            "indexSet": 0,            "onChainId": "string",            "status": "WON",            "bestBid": {              "price": 0.1,              "size": 0.1            },            "bestAsk": {              "price": 0.1,              "size": 0.1            },            "team": {              "id": 0,              "name": "string",              "abbreviation": "string",              "alias": "string",              "league": "string"            },            "variantData": {              "type": "ESPORTS_DOTA2",              "provider": "PREDICT_SPORTS",              "team": {                "id": 0,                "name": "string",                "abbreviation": "string",                "providerTeamId": "string",                "isHome": true,                "record": {                  "wins": 0,                  "losses": 0,                  "draws": 0,                  "overtimeLosses": 0                },                "color": "string"              }            },            "variantDetails": {              "sports": {                "provider": "PREDICT_SPORTS",                "team": {                  "id": 0,                  "name": "string",                  "abbreviation": "string",                  "providerTeamId": "string",                  "isHome": true,                  "record": {                    "wins": 0,                    "losses": 0,                    "draws": 0,                    "overtimeLosses": 0                  },                  "color": "string"                }              }            }          },          "signer": "string",          "hash": "string",          "fee": {            "amount": "string",            "type": "COLLATERAL"          }        }      ],      "transactionHash": "string",      "settlementId": "string",      "executedAt": "string"    }  ]}