Search API

The Search API provides full-text search across events by title or ticker.

Access

from dflow import DFlowClient
 
client = DFlowClient()
search_api = client.search

Methods

search

Search for events with nested markets.

def search(
    query: str,
    sort: SortField | None = None,
    order: SortOrder | None = None,
    limit: int | None = None,
    cursor: int | None = None,
    with_nested_markets: bool | None = None,
    with_market_accounts: bool | None = None,
    status: MarketStatus | None = None,
    entity_type: SearchEntityType | None = None,
) -> SearchResult

Parameters

Parameter	Type	Description
`query`	`str`	Search query string (required)
`sort`	`str \| None`	Sort field: `"volume"`, `"volume_24h"`, `"liquidity"`, `"open_interest"`, `"start_date"`
`order`	`str \| None`	Sort order: `"asc"`, `"desc"`
`limit`	`int \| None`	Maximum number of results
`cursor`	`int \| None`	Pagination cursor
`with_nested_markets`	`bool \| None`	Include nested markets in response
`with_market_accounts`	`bool \| None`	Include market account information
`status`	`str \| None`	Filter by status
`entity_type`	`str \| None`	Type of entity: `"events"`, `"markets"`, `"series"`

Example

# Basic search
results = client.search.search(query="bitcoin")
print(f"Found {len(results.events)} events")
 
# Search with sorting and pagination
results = client.search.search(
    query="election",
    sort="volume",
    order="desc",
    limit=20,
)
 
# Include nested markets with account info
results = client.search.search(
    query="sports",
    with_nested_markets=True,
    with_market_accounts=True,
)
 
for event in results.events:
    print(f"{event.title}")
    if event.markets:
        for market in event.markets:
            print(f"  - {market.title}: YES={market.yes_ask}")
 
# Paginate through results
if results.cursor:
    next_page = client.search.search(query="bitcoin", cursor=results.cursor)

Types

SearchResult

class SearchResult(BaseModel):
    cursor: int
    events: list[Event]

Search API

On this page