Method | HTTP request | Description |
---|---|---|
getEvent | GET /events/ | Get Event |
getEventMetadata | GET /events//metadata | Get Event Metadata |
getEvents | GET /events | Get Events |
getEvent
GetEventResponse getEvent()Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
eventTicker | [string] | Event ticker | defaults to undefined |
withNestedMarkets | [boolean] | If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. | (optional) defaults to false |
Return type
GetEventResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Event retrieved successfully | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |
getEventMetadata
GetEventMetadataResponse getEventMetadata()Get metadata about an event by its ticker
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
eventTicker | [string] | Event ticker | defaults to undefined |
Return type
GetEventMetadataResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Event metadata retrieved successfully | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |
getEvents
GetEventsResponse getEvents()Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the ‘limit’ parameter to control page size (1-200, defaults to 100). The response includes a ‘cursor’ field - pass this value in the ‘cursor’ parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
limit | [number] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100 |
cursor | [string] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined |
withNestedMarkets | [boolean] | If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. | (optional) defaults to false |
status | [string] | Filter by status. Possible values depend on the endpoint. | (optional) defaults to undefined |
seriesTicker | [string] | Filter by series ticker | (optional) defaults to undefined |
minCloseTs | [number] | Filter items that close after this Unix timestamp | (optional) defaults to undefined |
Return type
GetEventsResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Events retrieved successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |