Skip to main content
GET
/
api
/
v1
/
search
Get events with nested markets by title or ticker (search)
curl --request GET \
  --url https://dev-prediction-markets-api.dflow.net/api/v1/search \
  --header 'x-api-key: <api-key>'
{
  "cursor": 1,
  "events": [
    {
      "seriesTicker": "<string>",
      "subtitle": "<string>",
      "ticker": "<string>",
      "title": "<string>",
      "competition": "<string>",
      "competitionScope": "<string>",
      "imageUrl": "<string>",
      "liquidity": 1,
      "markets": [
        {
          "accounts": {},
          "canCloseEarly": true,
          "closeTime": 1,
          "eventTicker": "<string>",
          "expirationTime": 1,
          "marketType": "<string>",
          "noSubTitle": "<string>",
          "openInterest": 1,
          "openTime": 1,
          "result": "<string>",
          "rulesPrimary": "<string>",
          "status": "<string>",
          "subtitle": "<string>",
          "ticker": "<string>",
          "title": "<string>",
          "volume": 1,
          "yesSubTitle": "<string>",
          "earlyCloseCondition": "<string>",
          "noAsk": "<string>",
          "noBid": "<string>",
          "rulesSecondary": "<string>",
          "yesAsk": "<string>",
          "yesBid": "<string>"
        }
      ],
      "openInterest": 1,
      "settlementSources": [
        {
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "strikeDate": 1,
      "strikePeriod": "<string>",
      "volume": 1,
      "volume24h": 1
    }
  ]
}

​
What Search Covers

Search uses a multi-field, full-text query across events and markets.

​
Events (fields searched)

  • id (event ticker)
  • series_ticker (series ticker)
  • title
  • sub_title

​
Markets (fields searched)

  • id (market ticker)
  • event_ticker
  • title
  • yes_sub_title
  • no_sub_title

​
Fields Not Searched

Search does not query tags, categories, rules, competition fields, images, or settlement sources.

​
How Matching Works

  • The query is split on whitespace; all tokens must match.
  • Ticker fields (id, series_ticker, event_ticker) match upper and lower variants.
  • Text fields (title, sub_title, yes_sub_title, no_sub_title) use full-text matching.
  • Special characters are escaped before search.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Contact [email protected] to obtain an API key.

Query Parameters

​
q
string
required

The query string to search for

​
sort
enum<string>

Field to sort by

Available options:
volume,
volume24h,
liquidity,
openInterest,
startDate
​
order
enum<string>

How to order the results

Available options:
desc,
asc
​
limit
integer<int32>

How many records to limit the results to

Required range: x >= 0
​
cursor
integer<int32>

Cursor for pagination

Required range: x >= 0
​
withNestedMarkets
boolean

Include nested markets in response

​
withMarketAccounts
boolean

Include market account information (settlement mints and redemption status)

Response

Search results

​
cursor
integer<int32>
required
Required range: x >= 0
​
events
object[]
required