Racecheck

부분 유료
분류별 Racecheck | 업데이트됨 3달 전 | Health and Fitness
인기

5.9 / 10

지연 시간

1,460ms

서비스 수준

100%

Racecheck 개요

팔로워: 0
자원:
제품 웹사이트 이용 약관
API 생성자 :
avatar
Racecheck
racecheck
Rate API:
Rate API에 로그인

README

Gain access to tens of thousands of mass participation sports events worldwide. Ideal for fitness platforms/apps who want to increase retention and engagement with their users by facilitating event search, and to create additional revenue sources by curating plans and products around their users’ race calendars and event goals.

<h3><b>Request your access token: <a href=“https://api.racecheck.com/request-access-token/”>https://api.racecheck.com/request-access-token/</a></b></h3>

<h3><b>Read the latest official documentation: <a href=“https://api.racecheck.com/documentation/”>https://api.racecheck.com/documentation/</a></b></h3>

<hr />

<h3><b>Introduction</b></h3>
<p>The Racecheck API is structured around REST, HTTP, and JSON. All API endpoints are organized around models such as races, reviews, ratings, etc. The HTTP method <code>GET</code> is used to retrieve results. As the Racecheck API is still under active development the API endpoints and request structures are liable to change.</p>

<br /><br />

<h3><b>Errors</b></h3>
<p>Sometimes requests to the Racecheck API are not successful, and these failures can occur for a number of reasons. In the event of a failed request, the API will return an HTTP Status Code that can be used to determine the cause of the failure.</p>
<p>Use the table below to help understand what went wrong with your request.</p>
<table>
<thead>
<tr>
<th>Code</th>
<th>Header</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><b>400</b></td>
<td><b>Bad Request</b></td>
<td>The request could not be understood by the server due to incorrect syntax. Do not repeat the request before modifying request parameters/syntax.</td>
</tr>
<tr>
<td><b>403</b></td>
<td><b>Forbidden</b></td>
<td>Request syntax is correct, however the server will not complete the request due to the fact the user is not authorised to access the resource they are requesting.</td>
</tr>
<tr>
<td><b>404</b></td>
<td><b>Not Found</b></td>
<td>The server did not find a current representation for the target resource or is not willing to disclose that one exists.</td>
</tr>
<tr>
<td><b>500</b></td>
<td><b>Internal Server Error</b></td>
<td>The server encountered an unexpected condition that prevented it from fulfilling the request.</td>
</tr>
</tbody>
</table>

<br /><hr /><br />

<h3><b>Get races - <code>GET</code></b></h3>
<p>This API endpoint is used to retrieve and filter races.</p>
<p>Various query parameters can be used to refine and filter your results. Below is a list of supported parameters along with their rules, conventions and usage descriptions.</p>
<p>The response is in JSON format. The <code>count</code> indicates the number of results and the <code>next</code> and <code>previous</code> keys are used to determine whether there are additional pages that can be requested for the given filters. The <code>results</code> key contains the list of races matching the filtering criteria.</p>
<p><b>Parameters</b></p>

<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><b>event_type</b> (optional)</td>
<td>Either a single event type or a list of event types can be used to filter what type of events will be retrieved. The event types are: <code>road-running</code>, <code>off-road-running</code>, <code>triathlon</code>, <code>duathlon</code>, <code>cycling</code>, <code>swimming</code>, <code>ocr</code>, <code>aquathlon</code>, <code>swimrun</code>, <code>aquabike</code>, <code>virtual</code>.<br />The list of event types can also be retrieved from the <b>Get event types</b> API endpoint.</td>
</tr>
<tr>
<td><b>lat</b> (optional)</td>
<td>The latitude of the location around which the search will be performed.</td>
</tr>
<tr>
<td><b>lon</b> (optional)</td>
<td>The longitude of the location around which the search will be performed.</td>
</tr>
<tr>
<td><b>range</b> (optional)</td>
<td>The maximum range (in km) around the location in which the search will be performed. Default 100km, if location is well defined.</td>
</tr>
<tr>
<td><b>country</b> (optional)</td>
<td>The country (slug) in which the search will be performed. When applied, lat, lon and range fields are overwritten. <br />The list of countries can be retrieved from the <b>Get countries</b> API endpoint.</td>
</tr>
<tr>
<td><b>from_date</b> (optional)</td>
<td>Starting date in <code>YYYY-MM-DD</code> format. Default date is the current date.</td>
</tr>
<tr>
<td><b>to_date</b> (optional)</td>
<td>Ending date in <code>YYYY-MM-DD</code> format. No limit by default.</td>
</tr>
<tr>
<td><b>unit</b> (optional)</td>
<td>Can be <code>km</code> for kilometers or <code>mi</code> for miles. Default unit is kilometers.</td>
</tr>
<tr>
<td><b>min_distance</b> (optional)</td>
<td>The minimum distance value in the defined unit. Default no minimum distance value.</td>
</tr>
<tr>
<td><b>max_distance</b> (optional)</td>
<td>The maximum distance value in the defined unit. Default no maximum distance value.</td>
</tr>
<tr>
<td><b>distance_title</b> (optional)</td>
<td>The title of the distance. Must be a valid distance title for the specified event type from the distance title list. When applied, <code>min_distance</code> and <code>max_distance</code> fields are overwritten.<br />The list of distance titles per event type can also be retrieved from the <b>Get distance titles</b> API endpoint.<br /><br />
<table>
<tbody>
<tr>
<th><b>Running distance title</b></th>
<th>Min distance</th>
<th>Max distance</th>
</tr>
<tr>
<td><b>5km</b></td>
<td>5.00km</td>
<td>5.00km</td>
</tr>
<tr>
<td><b>10km</b></td>
<td>10.00km</td>
<td>10.00km</td>
</tr>
<tr>
<td><b>half-marathon</b></td>
<td>21.00km</td>
<td>21.20km</td>
</tr>
<tr>
<td><b>marathon</b></td>
<td>42.00km</td>
<td>42.30km</td>
</tr>
<tr>
<td><b>ultra</b></td>
<td>42.31km</td>
<td>-</td>
</tr>
</tbody>
</table>
<table>
<tbody>
<tr>
<th><b>Triathlon distance title</b></th>
<th>Min total distance</th>
<th>Max total distance</th>
</tr>
<tr>
<td><b>super-sprint</b></td>
<td>0.01km</td>
<td>20.90km</td>
</tr>
<tr>
<td><b>sprint</b></td>
<td>20.91km</td>
<td>40.00km</td>
</tr>
<tr>
<td><b>standard</b></td>
<td>40.01km</td>
<td>70.00km</td>
</tr>
<tr>
<td><b>middle</b></td>
<td>70.01km</td>
<td>150.00km</td>
</tr>
<tr>
<td><b>long</b></td>
<td>150.01km</td>
<td>230.00km</td>
</tr>
<tr>
<td><b>ultra</b></td>
<td>230.01km</td>
<td>-</td>
</tr>
</tbody>
</table>
<table>
<tbody><tr>
<th><b>Duathlon distance title</b></th>
<th>Min total distance</th>
<th>Max total distance</th>
</tr>
<tr>
<td><b>super-sprint</b></td>
<td>0.01km</td>
<td>22.00km</td>
</tr>
<tr>
<td><b>sprint</b></td>
<td>22.01km</td>
<td>42.00km</td>
</tr>
<tr>
<td><b>standard</b></td>
<td>42.01km</td>
<td>70.00km</td>
</tr>
<tr>
<td><b>long</b></td>
<td>70.01km</td>
<td>-</td>
</tr>
</tbody></table>
<table>
<tbody>
<tr>
<th><b>Cycling distance title</b></th>
<th>Min distance</th>
<th>Max distance</th>
</tr>
<tr>
<td><b>short</b></td>
<td>0.01km</td>
<td>50.00km</td>
</tr>
<tr>
<td><b>middle</b></td>
<td>50.01km</td>
<td>150.00km</td>
</tr>
<tr>
<td><b>long</b></td>
<td>150.01km</td>
<td>-</td>
</tr>
</tbody>
</table>
<table>
<tbody><tr>
<th><b>Swimming distance title</b></th>
<th>Min distance</th>
<th>Max distance</th>
</tr>
<tr>
<td><b>up-to-1km</b></td>
<td>0.01km</td>
<td>1.00km</td>
</tr>
<tr>
<td><b>up-to-3km</b></td>
<td>1.01km</td>
<td>3.00km</td>
</tr>
<tr>
<td><b>3km+</b></td>
<td>3.01km</td>
<td>-</td>
</tr>
</tbody></table>
<table>
<tbody><tr>
<th><b>OCR distance title</b></th>
<th>Min distance</th>
<th>Max distance</th>
</tr>
<tr>
<td><b>up-to-5km</b></td>
<td>0.01km</td>
<td>5.00km</td>
</tr>
<tr>
<td><b>up-to-10km</b></td>
<td>5.01km</td>
<td>10.00km</td>
</tr>
<tr>
<td><b>10km+</b></td>
<td>10.01km</td>
<td>-</td>
</tr>
</tbody></table>
<table>
<tbody><tr>
<th><b>Aquathlon distance title</b></th>
<th>Min total distance</th>
<th>Max total distance</th>
</tr>
<tr>
<td><b>short</b></td>
<td>0.01km</td>
<td>12.00km</td>
</tr>
<tr>
<td><b>middle</b></td>
<td>12.01km</td>
<td>20.00km</td>
</tr>
<tr>
<td><b>long</b></td>
<td>20.01km</td>
<td>-</td>
</tr>
</tbody>
</table>
<table>
<tbody><tr>
<th><b>Swimrun distance title</b></th>
<th>Min total distance</th>
<th>Max total distance</th>
</tr>
<tr>
<td><b>short</b></td>
<td>0.01km</td>
<td>15.00km</td>
</tr>
<tr>
<td><b>middle</b></td>
<td>15.01km</td>
<td>40.00km</td>
</tr>
<tr>
<td><b>long</b></td>
<td>40.01km</td>
<td>-</td>
</tr>
</tbody>
</table>
<table>
<tbody><tr>
<th><b>Aquabike distance title</b></th>
<th>Min total distance</th>
<th>Max total distance</th>
</tr>
<tr>
<td><b>short</b></td>
<td>0.01km</td>
<td>31.00km</td>
</tr>
<tr>
<td><b>intermediate</b></td>
<td>31.01km</td>
<td>52.00km</td>
</tr>
<tr>
<td><b>long</b></td>
<td>52.01km</td>
<td>103.00km</td>
</tr>
<tr>
<td><b>ultra</b></td>
<td>103.01km</td>
<td>-</td>
</tr>
</tbody>
</table>
</td>
</tr>

    <tr>
        <td><b>event_features</b> (optional)</td>
        <td>Either a single event feature or a list of event features can be used to filter what type of events will be retrieved. Default includes all event features. The event features are: <code>suitable-for-beginners</code>, <code>spectator-friendly</code>, <code>babysitting-facilities-available</code>, <code>women-only</code>, <code>free-parking</code>, <code>post-event-food-and-refreshments</code>, <code>free-massage</code> and <code>family-entertainment</code>.<br />The list of event features can also be retrieved from the <b>Get event features</b> API endpoint.</td>
    </tr>
    <tr>
        <td><b>course_features</b> (optional)</td>
        <td>Course features are sport category specific, and therefore you can only specific the course features for a single sport category. Default all course features for all sport categories. Both the <code>course_features_sport</code> and <code>course_features</code> parameters must be defined.<br />The list of course features can also be retrieved from the <b>Get course feartures</b> API endpoint.
            <br /><br />
            <table>
            <tbody><tr>
                <th>Sport category</th>
                <th>Course features</th>
            </tr>
            <tr>
                <td><b>running</b></td>
                <td><b>mostly-flat</b>, <b>hilly</b>, <b>undulating</b></td>
            </tr>
            <tr>
                <td><b>swimming</b></td>
                <td><b>pool</b>, <b>river</b>, <b>lake</b>, <b>sea</b></td>
            </tr>
            <tr>
                <td><b>cycling</b></td>
                <td><b>mostly-flat</b>, <b>hilly</b>, <b>undulating</b></td>
            </tr>
        </tbody>
    </table>
    </td>
    </tr>
    <tr>
        <td><b>age_range</b> (optional)</td>
        <td>Can be either <code>adult</code> or <code>junior</code>. Default all age ranges.</td>
    </tr>
    <tr>
        <td><b>min_average_rating</b> (optional)</td>
        <td>The minimum total average rating of the event. Default no minimum average rating.</td>
    </tr>
    <tr>
        <td><b>min_reviews</b> (optional)</td>
        <td>The minimum number of reviews an event must have to be returned. Default no minimum number of reviews.</td>
    </tr>
    <tr>
        <td><b>sorting</b> (optional)</td>
        <td>A single parameter (<code>distance</code>, <code>date</code>, <code>average_rating</code> or <code>reviews</code>) can by specified by which the results will be sorted in ascending (<code>asc</code>) or descending (<code>desc</code>) order. Default sorting is <code>date</code>,<code>asc</code>.</td>
    </tr>
    <tr>
        <td><b>page</b> (optional)</td>
        <td>The page number to retrieve. Default page value is <code>1</code>. Returns empty results list if page exceeds the maximum number of pages.</td>
    </tr>
</tbody>

</table>

<br /><br />

<h3><b>Race search - <code>GET</code></b></h3>
<p>This API endpoint is used to search for Races based on their name and accepts a single parameter, as explained below.</p>
<p>The response is in JSON format. The <code>count</code> indicates the number of results and the <code>next</code> and <code>previous</code> keys are used to determine whether there are additional pages that can be requested for the given filters. The <code>results</code> key contains the list of races matching the filtering criteria.</p>
<p><b>Parameters</b></p>

<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>q (*required)</td>
<td>A string that is to be used as the query term.</td>
</tr>
</tbody>
</table>

<br /><hr /><br />

<h3><b>Get event reviews - <code>GET</code></b></h3>
<p>This API endpoint is used to retrieve all reviews that have been left for the event provided in the URL.</p>
<p>The response is in JSON format. The <code>count</code> indicates the number of results and the <code>next</code> and <code>previous</code> keys are used to determine whether there are additional pages that can be requested for the given filters. The <code>results</code> key contains the list of races matching the filtering criteria.</p>
<p><b>Parameters</b></p>

<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><b>event_id</b> (*required)</td>
<td>The numeric event ID for which you want to retrieve reviews for. The event_id can be found in a <b>Race Search</b> or <b>Get Races</b> response.</td>
</tr>
</tbody>
</table>

<br /><br />

<h3><b>Get event reviews by year - <code>GET</code></b></h3>
<p>This API endpoint is used to retrieve all reviews from the specified year that have been left for the event provided in the URL.</p>
<p>The response is in JSON format. The <code>count</code> indicates the number of results and the <code>next</code> and <code>previous</code> keys are used to determine whether there are additional pages that can be requested for the given filters. The <code>results</code> key contains the list of races matching the filtering criteria.</p>
<p><b>Parameters</b></p>

<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><b>event_id</b> (*required)</td>
<td>The numeric event ID for which you want to retrieve reviews for. The event_id can be found in a <b>Race Search</b> or <b>Get Races</b> response.</td>
</tr>
<tr>
<td><b>year</b> (*required)</td>
<td>The year for which you want to retrieve reviews from.</td>
</tr>
</tbody>
</table>

<br /><hr /><br />

<h3><b>Get event types - <code>GET</code></b></h3>
<p>This API endpoint is used to retrieve all existing event types.</p>
<p>The response is in JSON format. The <code>results</code> key contains the list of supported event types, along with their slugs, that can be used as query parameters in <b>Get races</b> requests.</p>

<br /><br />

<h3><b>Get distance titles - <code>GET</code></b></h3>
<p>This API endpoint is used to retrieve distance titles.</p>
<p>Retrieves all existing distance titles per event type. An event type slug can be specified in the URL to filter the results.</p>
<p>The response is in JSON format. The <code>results</code> key contains the list of supported distance titles (per event type), along with their slugs, that can be used as query parameters in <b>Get races</b> requests.</p>
<p><b>Parameters</b></p>

<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><b>event_type</b> (optional)</td>
<td>The slug of the event type for which you want to retrieve the distance titles for. The event_type can be found in a <b>Get event types</b> response.</td>
</tr>
</tbody>
</table>

<br /><br />

<h3><b>Get event features - <code>GET</code></b></h3>
<p>This API endpoint is used to retrieve all existing event features.</p>
<p>The response is in JSON format. The <code>results</code> key contains the list of supported distance titles (per event type), along with their slugs, that can be used as query parameters in <b>Get races</b> requests.</p>

<br /><br />

<h3><b>Get course features - <code>GET</code></b></h3>
<p>This API endpoint is used to retrieve all existing course features.</p>
<p>The response is in JSON format. The <code>results</code> key contains the list of supported course features per activity, that can be used as query parameters in <b>Get races</b> requests.</p>

<br /><br />

<h3><b>Get countries - <code>GET</code></b></h3>
<p>This API endpoint is used to retrieve all supported countries.</p>
<p>The response is in JSON format. The <code>results</code> key contains the list of supported countries, along with their slugs, that can be used as query parameters in <b>Get races</b> requests.</p>

등급: 5 - 투표: 1