API V4.0

Search Regattas

This service will return a list of regattas based on the supplied filters. This can be based on a location, timeframe, type of regatta and access. These search filters can be applied singularly, or in any combination.

The keywords are case sensitive. If you capitalize or mis-spell a keyword, the keyword will be ignored in the filter and you will likely receive many more regattas than you expect.

URL: https://api.regattacentral.com/v4.0​/regattas?{filters}

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Filters

authorized
List only regattas which the user is authorized to access and modify data.

Security This endpoint requires a valid OAuth2 token for authentication.

country={code}
The 2 letter country code specifying the location of the regatta

name={term}
Filters regattas with a full or abbreviated regatta name which contains this string

type={type}
Specifies the type of regatta
sprint - Only show Sprint format regattas
head - Only show Head format regattas
head/sprint - Only show Head/Sprint foramt regattas
henley - Only show Henley format regattas
indoor - Only show indoor regattas
coastal - Only show coastal regattas
open water - Only show open water regattas

year={nnnn}
The year in which the regatta will be or was held

timeframe={keyword}
The keyword specifies the timeframe you wish to search
upcoming - Only show regattas in the future
previous - Only show regattas in the past
today - Only show regattas that are taking place today

latitude={dd.ddd}
The latitude that is the center of a search area

longitude={dd.ddd}
The longitude that is the center of a search area

distance={nn}
The distance around the center to search (defaults to miles)

units={unit)
The distance units.
miles - miles from the latitude/longitude provided
meters - meter from the latitude/longitude provided
m - meters from the latitude/longitude provided
meters - kilometers from the latitude/longitude provided
kkm - kilometers from the latitude/longitude provided

Returns

JSON XML
A Regattas structure of all of the regattas matching the specified criteria. A maximum of 100 regattas will be returned.

Data:

Only Regattas with full access
Previous
Today
Upcoming
Sprint
Head
Indoor

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/regattas',
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Organizations

This service will return all organizations with a name that contains the search term

URL: https://api.regattacentral.com/v4.0​/organizations?name={Term}

Security This endpoint requires a valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

Term
The name that will be used to search by.

Returns

JSON XML
An Organizations structure, including an array of one or more organizations whose names include the requested term.

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/organizations?name=columbus',
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Data:

Results: JSON

Participants

This service will return all athletes whose first or last name contains the search term and whose birthday matches the supplied birthdate

URL: https://api.regattacentral.com/v4.0​/participants?lastname={Term}&birthdate={Birthday}

Security This endpoint requires a valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

Term
The search term that will be used

Birthday
The participant's birthday in the format YYYY-MM-DD

Returns

JSON XML
A Participants structure, including an array of one or more participants whose name includes the search term and whose birthday matches the input birthdate.

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/participants?lastname=smith&birthdate=1965-06-24',
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Data:

Results: JSON

Countries with Regattas

This service will return a list of countries where regattas are being held that are registered with RegattaCentral

URL: https://api.regattacentral.com/v4.0​/countries

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Returns

JSON XML
A Regattas structure with a separate Regatta structure for each country. The venue structure contains the country information.

Code: JavaScript + jQuery

											$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/countries',
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

RegattaCentral © 2024 | Support | Privacy