Search API
Search for events and markets by keyword
Search API
The Search API allows you to find events and their nested markets by searching titles and tickers.
Access
Methods
search
Search for events matching a query string.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | The search query string |
sort | SortField | No | Sort field: 'volume', 'volume_24h', 'liquidity', 'open_interest', 'start_date' |
order | 'asc' | 'desc' | No | Sort order |
limit | number | No | Maximum results to return |
cursor | number | No | Pagination cursor |
withNestedMarkets | boolean | No | Include nested markets in response |
withMarketAccounts | boolean | No | Include market account information |
status | MarketStatus | No | Filter by status |
entityType | 'events' | 'markets' | 'series' | No | Type of entity to search for |
Returns: SearchResult