Gets a list of races, with information similar to Get Race, except that only the most current events are listed. Event start and end times are in the timezone of the race. All other dates/times are in Eastern Time. The races are separated into pages. The maximum number of races per page is 1,000.
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
api_key |
GET | API Key | string |
|
api_secret |
GET | API Secret | string |
|
tmp_key |
GET | Temporary API Key from login API call. This should NOT be used in combination with API Key. | string |
|
tmp_secret |
GET | Temporary API Secret from login API call. This should NOT be used in combination with API Secret. | string |
|
rsu_api_key |
GET | API v2 key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET. | string |
|
sp_api_key |
GET | Super partner API key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET. | string |
|
X-RSU-API-SECRET |
HTTP Header | API v2 or super partner secret. | string |
|
format |
GET | xml | Format of response. The default if not sent is `xml`, but `json` is preferred. | format |
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
aflt_token |
GET | If set, this affiliate token will be appended to race URLs. | string |
|
events |
GET | F | Includes race events in the output. | bool |
race_headings |
GET | F | Include race headings in the output. | bool |
race_links |
GET | F | Include race links in the output. | bool |
include_waiver |
GET | F | Should waiver be included? | bool |
include_multiple_waivers |
GET | F | Should multiple waivers be included? | bool |
include_event_days |
GET | F | Should information on events days (e.g. each race year) be included? | bool |
include_extra_date_info |
GET | F | Should extra information about cancellations and postponements be included? | bool |
page |
GET | 1 | Page number to get. | uint |
results_per_page |
GET | 50 | Number of results per page. | uint |
sort |
GET | name ASC | Sort by "name", "date", or "end_date" in ascending ("ASC") or descending ("DESC") order. | string |
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
name |
GET | Search by race name. | string |
|
start_date |
GET | today | Searches for races that occur on or after a given date. | date |
end_date |
GET | Searches for races that occur on or before a given date. | date |
|
created_since |
GET | Searches for races that were created on or after a given date. | date |
|
created_on_or_before |
GET | Searches for races that were created on or before a given date. | date |
|
modified_since |
GET | Searches for races that were modified on or after a given date. | date |
|
modified_on_or_before |
GET | Searches for races that were modified on or before a given date. | date |
|
only_partner_races |
GET | F | Only get races linked to the partner using the API. | bool |
search_start_date_only |
GET | F | Only search race races based on start date, not end date. | bool |
only_races_with_results |
GET | F | Only get races that have results. | bool |
city |
GET | Search by city. | string |
|
state |
GET | Search by state. | state |
|
country |
GET | Search by country. | country |
|
event_type |
GET | Get races by event type. | event_type |
|
min_distance |
GET | Minimum race distance to get. | float |
|
max_distance |
GET | Maximum race distance to get. | float |
|
distance_units |
GET | K | Units to use with distance. | distance_units |
zipcode |
GET | Searches for races within radius(required) miles from zipcode. US Only. | string |
|
radius |
GET | Searches for races within radius miles from zipcode(required). | uint |
