Racemap Live Tracking Documentation

https://docs.racemap.com/
Admin
This project provides documentation for Racemap's live tracking system, covering APIs, GPS device...
Tokens:59,290
Snippets:622
Trust Score:9.1
Update:4 months ago
Show doc for...
Tokens:
Raw
### Loads API Query Parameters Example

Source: https://docs.racemap.com/data-export-from-racemap/loads-api.md

Example demonstrating the format for startTime and endTime query parameters in UTC.

```http
https://racemap.com/api/events/66e1410315ad59b9f52f192/pageviews?startTime=2024-09-11T06:00:00.000Z&endTime=2024-09-11T09:00:00.000Z
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.racemap.com/data-export-from-racemap/self-hosted-elevation-service.md

Demonstrates how to query the documentation dynamically by making an HTTP GET request to the page URL with an 'ask' query parameter.

```http
GET https://docs.racemap.com/data-export-from-racemap/self-hosted-elevation-service.md?ask=<question>
```

--------------------------------

### Example: Generate QR Code for a Specific Key

Source: https://docs.racemap.com/apps/tracking/keys.md

Example of generating a QR code for the key '6G615L'. The output is an image that can be embedded or displayed.

```json
https://racemap.com/api/starters/actions/generate_key_qrcode?key=6G615L
```

--------------------------------

### JSON Data Import Examples

Source: https://docs.racemap.com/api-import-and-export-data/import-basics/metadata-api.md

Provides examples of participant data in JSON format for import. Each object represents a participant with various attributes.

```javascript
[ 
  { 
    "importId": "UniqueImportID_0", 
    "name": "Petra Pan Minimal", 
    "startNumber": "A1206", 
    "tags.age": "25", 
    "tags.sex": "w" 
  }, 
  { 
    "importId": "UniqueImportID_1", 
    "name": "Peter Pan With Color", 
    "startNumber": "A1207", 
    "markerColor": "#4d79ff", 
    "tags.age": "35", 
    "tags.sex": "m" 
  }, 
  { 
    "importId": "UniqueImportID_3", 
    "name": "Peter Pan With Tracker and specific type/class", 
    "startNumber": "A1209", 
    "device.class": "Tracker", 
    "device.type": "Gl300", 
    "device.id": "001111112222223" 
  }, 
  { 
    "importId": "UniqueImportID_4", 
    "name": "Peter Pan With Times", 
    "startNumber": "A1210", 
    "times.start": "2020-04-24T14:30:06.708Z", 
    "times.end": "2020-04-24T15:30:06.708Z" 
  }, 
  { 
    "importId": "UniqueImportID_4", 
    "name": "Peter Pan With Start and End Times", 
    "startNumber": "A1210", 
    "startTime": "2020-04-25T14:30:06.708Z", 
    "endTime": "2020-04-25T15:30:06.708Z" 
  } 
]
```

--------------------------------

### API Query Example

Source: https://docs.racemap.com/api-import-and-export-data/import-basics/metadata-import-via-rr.md

Demonstrates how to query the documentation API by appending an 'ask' parameter with a natural language question to the URL.

```HTTP
GET https://docs.racemap.com/api-import-and-export-data/import-basics/metadata-import-via-rr.md?ask=<question>
```

--------------------------------

### Query Documentation with API

Source: https://docs.racemap.com/api-import-and-export-data/import-basics.md

To get information not directly on a page, make an HTTP GET request to the page URL with the `ask` query parameter. The question should be specific and in natural language.

```bash
GET https://docs.racemap.com/api-import-and-export-data/import-basics.md?ask=<question>
```

--------------------------------

### XML Data Import Examples

Source: https://docs.racemap.com/api-import-and-export-data/import-basics/metadata-api.md

Illustrates participant data structure in XML format for import. Each 'starters' element represents a participant.

```xml
<root>
  <starters>
    <importId>UniqueImportID_0</importId>
    <name>Petra Pan Minimal</name>
    <startNumber>A1206</startNumber>
    <tags>
       <age>25</age>
       <sex>w</sex>
    </tags>
  </starters>
  <starters>
    <importId>UniqueImportID_1</importId>
    <name>Peter Pan With Color</name>
    <startNumber>A1207</startNumber>
    <markerColor>#4d79ff</markerColor>
    <tags>
      <age>35</age>
     <sex>m</sex>
    </tags>
  </starters>
  <starters>
    <importId>UniqueImportID_2</importId>
    <name>Peter Pan With Tracker</name>
    <startNumber>A1208</startNumber>
```

--------------------------------

### Query Documentation with HTTP GET

Source: https://docs.racemap.com/api/participants.md

Use this endpoint to ask questions about the documentation. The response includes a direct answer and relevant excerpts.

```bash
GET https://docs.racemap.com/api/participants.md?ask=<question>
```

--------------------------------

### Start UART Logging

Source: https://docs.racemap.com/gps-devices/debugging.md

Send this command to the device to initiate the sending of all logs via UART.

```bash
AT+UARTLOG=9
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.racemap.com/prediction/test.md

To get additional information not directly on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.racemap.com/prediction/test.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.racemap.com/api/auto-pausation.md

To get specific information not found on the page, send an HTTP GET request to the page URL with an 'ask' query parameter. The response will include a direct answer and relevant documentation excerpts.

```http
GET https://docs.racemap.com/api/auto-pausation.md?ask=<question>
```

--------------------------------

### Retrieve Event Starters

Source: https://docs.racemap.com/api/authentication.md

This example demonstrates how to retrieve participants from an event using an API token. The token is passed in the Authorization header.

```APIDOC
## GET /api/events/:eventId/starters

### Description
Retrieves a list of participants for a specified event.

### Method
GET

### Endpoint
`/api/events/:eventId/starters`

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The unique identifier of the event.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl --location 'https://racemap.com/api/events/:eventId/starters' \
--header 'Authorization: Bearer <API_TOKEN>'
```

### Response
#### Success Response (200)
- **starters** (array) - A list of participant objects.

#### Response Example
```json
{
  "starters": [
    {
      "id": "participant123",
      "name": "John Doe",
      "bib": "101"
    }
  ]
}
```
```

--------------------------------

### RACE|RESULT API Integration Example

Source: https://docs.racemap.com/api/times.md

This example demonstrates how to format data from the Racemap '/times' API to be compatible with the RACE|RESULT API for importing virtual detections. It shows the required URL parameters for event ID, API key, bib number, time, and timing point.

```bash
https://api.raceresult.com/180472/G5XQYZKPIPU5J1RSCVIZ48QKVU5JIIJP?&bib=1&time=36600&TimingPoint=Messstelle1
```

--------------------------------

### Ask a Question via HTTP GET Request

Source: https://docs.racemap.com/how-to-use-live-tracking/gps-timing

To retrieve information when a specific page is not found, perform an HTTP GET request to the documentation index with an 'ask' parameter. The question should be specific and in natural language.

```HTTP
GET https://docs.racemap.com/live-tracking/gps-timing.md?ask=<question>
```

--------------------------------

### Query Documentation with API

Source: https://docs.racemap.com/api-import-and-export-data.md

To get information not directly available on a page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.racemap.com/api-import-and-export-data.md?ask=<question>
```

--------------------------------

### Query Firmware Update Status

Source: https://docs.racemap.com/gps-devices/config/firmware.md

This example shows how to query the current firmware version of devices. This is automatically requested after a firmware update.

```HTTP
GET https://docs.racemap.com/gps-devices/config/firmware.md?ask=<question>
```

--------------------------------

### Ask a Question via HTTP GET

Source: https://docs.racemap.com/hardware-for-live-tracking/debugging

Use this method to query the documentation index for specific information. Append your question as the 'ask' parameter to the documentation URL.

```http
GET https://docs.racemap.com/gps-devices/debugging.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.racemap.com/data-export-from-racemap/download-gps-results.md

Perform an HTTP GET request to query the documentation. Use this when the answer is not explicitly present, requires clarification, or you want to retrieve related sections.

```http
GET https://docs.racemap.com/data-export-from-racemap/download-gps-results.md?ask=<question>
```

--------------------------------

### Loads API Sample Request URL

Source: https://docs.racemap.com/data-export-from-racemap/loads-api.md

Example of a request URL for retrieving loads data for a specific event and time range.

```http
https://racemap.com/api/events/66bf4318d1c783279d183dd3/pageviews?startTime=2022-09-19T14:00:19.000Z&endTime=2024-09-23T23:59:59.999Z
```

--------------------------------

### Ask a Question via HTTP GET Request

Source: https://docs.racemap.com/hardware-for-live-tracking

Use this method to query the documentation index for specific information. Append your question as the 'ask' parameter to the documentation URL.

```HTTP
GET https://docs.racemap.com/live-tracking.md?ask=<question>
```

--------------------------------

### HTTP GET Request to Query Documentation

Source: https://docs.racemap.com/integrations/wiclax.md

Use this method to ask questions about the documentation when the answer is not explicitly present on the page, or when you need clarification or additional context.

```http
GET https://docs.racemap.com/integrations/wiclax.md?ask=<question>
```

--------------------------------

### GET /api/data/v1/:eventId/ranks

Source: https://docs.racemap.com/api/ranks.md

Retrieves the ranks and results for a specific event. This endpoint provides detailed information about the event, including its name, location, start and end times, and an array of split objects.

```APIDOC
## GET /api/data/v1/:eventId/ranks

### Description
Retrieves the ranks and results for a specific event. This endpoint provides detailed information about the event, including its name, location, start and end times, and an array of split objects.

### Method
GET

### Endpoint
`https://racemap.com/api/data/v1/:eventId/ranks`

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The unique identifier of the event.

### Response
#### Success Response (200)
- **name** (string) - Name of event.
- **location** (string) - Location of the event.
- **startTime** (string) - Start time in UTC.
- **endTime** (string) - End time in UTC.
- **timekeepings** (array) - Array for split objects.
- **starters** (array) - Array for participant objects.

#### Split object
- **name** (string) - Name of split.
- **offset** (number) - Distance [m] along the shadowtrack.
- **position** (array) - Array with longitude, latitude, altitude [m].
- **id** (string) - Unique Racemap ID of split.

### Response Example
```json
{
  "name": "Sample | 100km Duathlon",
  "location": "🇩🇪 Dresden",
  "startTime": "2020-04-25T06:00:00.000Z",
  "endTime": "2020-10-30T18:15:00.000Z",
  "timekeepings": [
    {
      "name": "Finish",
      "offset": 100262.4279943064,
      "position": [13.704038205094022, 51.02687962934201, 166],
      "id": "64513872c3ab09659eb09683"
    }
  ],
  "starters": []
}
```
```

--------------------------------

### Coordinates Array Example

Source: https://docs.racemap.com/api/geo-elements.md

An example of how coordinates are structured within a geo-element object. It includes longitude, latitude, and altitude.

```json
{
        "coordinates": [13.605496742105894, 51.094757189936146, 106]
      }
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.racemap.com/integrations.md

Use this method to ask questions about the documentation. The response includes a direct answer, relevant excerpts, and sources.

```http
GET https://docs.racemap.com/integrations.md?ask=<question>
```

--------------------------------

### Query Documentation

Source: https://docs.racemap.com/readme.md

To get specific information not found on the current page, send an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://docs.racemap.com/readme.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.racemap.com/data-export-from-racemap.md

Use this method to ask questions about the documentation. The response includes direct answers and relevant excerpts.

```HTTP
GET https://docs.racemap.com/data-export-from-racemap.md?ask=<question>
```

--------------------------------

### Set API Token and Run Forwarder (Windows - GUI)

Source: https://docs.racemap.com/prediction/timekeeping/other-timingsystem/forwarder.md

This demonstrates setting the API token as an environment variable and running the forwarder executable on Windows, typically used when launching the application via the GUI or a script.

```sh
set RACEMAP_API_TOKEN=[APItoken]
.\2-racemap-forwarder.exe
```

--------------------------------

### Query Documentation API

Source: https://docs.racemap.com/api/distance.md

To get additional information not directly present on a page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.racemap.com/api/distance.md?ask=<question>
```

--------------------------------

### Query Starter Keys

Source: https://docs.racemap.com/apps/tracking/keys.md

Endpoint to automatically retrieve starter keys for an event. The response format can be specified.

```APIDOC
## Query Starter Keys

### Description
Endpoint to automatically retrieve keys.

### Method
GET

### Endpoint
`https://racemap.com/api/events/:evenId/starter_keys?format=json`

### Parameters
#### Path Parameters
- **evenId** (string) - Required - The ID of the event.

#### Query Parameters
- **format** (string) - Optional - The desired format for the retrieved keys (e.g., `json`).
```

--------------------------------

### Generate Starter Keys

Source: https://docs.racemap.com/apps/tracking/keys.md

Endpoint to automatically generate starter keys on demand for an event. You can specify the number of keys to generate.

```APIDOC
## Generate Starter Keys

### Description
Endpoint to automatically generate keys on demand.

### Method
GET

### Endpoint
`https://racemap.com/api/events/:eventId/actions/generate_starter_keys?count=<count>`

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The ID of the event.

#### Query Parameters
- **count** (integer) - Required - The number of keys to generate.
```

--------------------------------

### GET /events/:eventId/geo/splits

Source: https://docs.racemap.com/api/geo-elements.md

Retrieves only the splits of a tracking map for a specific event.

```APIDOC
## GET /events/:eventId/geo/splits

### Description
Retrieves only the splits of a tracking map for a specific event.

### Method
GET

### Endpoint
`https://racemap.com/api/events/:eventId/geo/splits`

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The unique identifier of the event.

### Request Example
```http
GET /api/events/61a2055b10cacc0001302283/geo/splits HTTP/1.1
Host: racemap.com
```

### Response
#### Success Response (200)
Returns an array of split objects.

#### Geo element object fields (relevant for splits):
- **racemapType** (string) - Should be `"split"`.
- **name** (string) - Name of the split.
- **shortName** (string) - Short name of the split.
- **color** (string) - Color of the split.
- **hidden** (boolean) - Visibility of the split.
- **timekeeping** (boolean) - Indicates if the split is used in the leaderboard.
- **newSport** (string) - Indicates the start of a new sport segment.
- **lineStringId** (string) - ID of the track to which this split is associated.
- **coordinateIndex** (integer) - The index of the coordinate on the track to which the split is assigned.
- **offset** (number) - The distance in meters on the track where the split is set.
- **resetSpeed** (number) - Velocity in km/h used for prediction.
- **minSpeed** (number) - Minimum velocity in km/h used for prediction.
- **id** (string) - Unique ID of the split element.

### Response Example
```json
[
  {
    "racemapType": "split",
    "eventId": "61a2055b10cacc0001302283",
    "name": "Marathon",
    "shortName": "M",
    "color": "#32c4f7",
    "hidden": false,
    "timekeeping": true,
    "newSport": "running",
    "lineStringId": "64514d7ec3ab09659eb29e71",
    "coordinateIndex": 253,
    "offset": 19029.765609128,
    "resetSpeed": null,
    "minSpeed": null,
    "id": "64514d7ec3ab09659eb29e71"
  }
]
```
```

--------------------------------

### Set API Token and Run Forwarder (Linux)

Source: https://docs.racemap.com/prediction/timekeeping/other-timingsystem/forwarder.md

This command exports the RACEMAP API token as an environment variable and then executes the forwarder binary on Linux. Replace '[APItoken]' with your actual token.

```sh
export RACEMAP_API_TOKEN=[APItoken]
./2-racemap-forwarder
```

--------------------------------

### Get Times for a Specific Checkpoint

Source: https://docs.racemap.com/api/times.md

Retrieves all detections (reads) for a specific checkpoint within an event.

```APIDOC
## GET /api/data/v1/:eventId/times/:checkpointId

### Description
Retrieves all detections (reads) for a specific checkpoint (virtual timekeeping point) within a given event. This endpoint is a variation of the main /times endpoint, filtered by a checkpoint ID.

### Method
GET

### Endpoint
/api/data/v1/:eventId/times/:checkpointId

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The unique identifier for the event.
- **checkpointId** (string) - Required - The unique identifier of the virtual timekeeping point (checkpoint) to retrieve reads for.

### Response
#### Success Response (200)
Returns an array of Checkpoint objects representing the reads for the specified checkpoint in chronological order.

#### Checkpoint object
| Field | Description | Sample |
|---|---|---|
| `name` | Name of virtual timekeeping point | `"Split 5"` |
| `offset` | Distance [m] along the shadowtrack | `49222.81` |
| `id` | Unique Racemap ID of timekeeping point | `"6450e60747adaed475b48"` |
| `position` | Array with longitude, latitude, hight [m] | `13.881129999, 51.075250000, 250` |
```

--------------------------------

### GET /events/:eventId/geo/shadow.json

Source: https://docs.racemap.com/api/geo-elements.md

Retrieves the shadow track and the splits of a tracking map for a specific event.

```APIDOC
## GET /events/:eventId/geo/shadow.json

### Description
Retrieves the shadow track and the splits of a tracking map for a specific event.

### Method
GET

### Endpoint
`https://racemap.com/api/events/:eventId/geo/shadow.json`

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The unique identifier of the event.

### Request Example
```http
GET /api/events/61a2055b10cacc0001302283/geo/shadow.json HTTP/1.1
Host: racemap.com
```

### Response
#### Success Response (200)
Returns data including shadow track information and split details.

#### Geo element object fields (relevant for shadow.json):
- **racemapType** (string) - Can be `"track"` or `"split"`.
- **eventId** (string) - Unique id of tracking map.
- **name** (string) - Name of geo element.
- **shortName** (string) - Short name of POI or split.
- **color** (string) - Color of geo element.
- **hidden** (boolean) - Visibility in tracking map.
- **icon** (string) - URL of image for POIs.
- **timekeeping** (boolean) - Split in leaderboard or geofence.
- **readerIds** (array of strings) - IDs of decoders.
- **newSport** (string) - Start of a new segment.
- **lineStringId** (string) - ID of the track to which this split is associated.
- **coordinateIndex** (integer) - Number of the coordinate of the track.
- **creatorId** (string) - User id of the event host.
- **length** (number) - Length of the track in km.
- **pointCount** (integer) - Number of points of the track.
- **offset** (number) - Length in meters on which the split is set on the track.
- **resetSpeed** (number) - Velocity in km/h used for prediction.
- **minSpeed** (number) - Velocity in km/h used for prediction.
- **oldId** (string) - An old reference to the geo element.
- **createdAt** (string) - Timestamp of when the element was added.
- **updaterId** (string) - ID of the user that updated the element latest.
- **updatedAt** (string) - Timestamp of latest update of the element.
- **id** (string) - Unique id of geo element.

### Response Example
```json
{
  "racemapType": "track",
  "eventId": "61a2055b10cacc0001302283",
  "name": "Track 0",
  "color": "#ffffff",
  "hidden": false,
  "creatorId": "51782b0cd37706937400000d",
  "length": 99.50403889646452,
  "pointCount": 1192,
  "oldId": "cf31ed00-d2a1-47c3-8306-fd55b09a1bb0",
  "createdAt": "2021-09-10T03:04:07.020Z",
  "updaterId": "c001cafe15abad1deabada55",
  "updatedAt": "2023-05-02T17:50:54.304Z",
  "id": "64514d7ec3ab09659eb29e71"
}
```
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.racemap.com/prediction/timekeeping.md

Use this method to ask questions about the documentation when the answer is not explicitly present. The response includes a direct answer, relevant excerpts, and sources.

```http
GET https://docs.racemap.com/prediction/timekeeping.md?ask=<question>
```

--------------------------------

### Get All Times for an Event

Source: https://docs.racemap.com/api/times.md

Retrieves all detections (reads) for an event. Detections are generated if a location meets event and geofence criteria.

```APIDOC
## GET /api/data/v1/:eventId/times

### Description
Retrieves all detections (reads) for a given event. A detection is generated when a location point satisfies three conditions: the device ID belongs to the event, the location is within the geofence radius, and the location's timestamp is between the event's start and end times.

### Method
GET

### Endpoint
/api/data/v1/:eventId/times

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The unique identifier for the event.

#### Query Parameters
- **id** (string) - Optional - The unique identifier of a specific checkpoint (virtual timekeeping point) to retrieve reads for that geofence in chronological order.

### Response
#### Success Response (200)
Returns an Event object containing details about the event and its associated timekeeping points and starters. If an `id` query parameter is provided, it returns an array of Checkpoint objects for that specific timekeeping point.

#### Event object
| Field | Description [unit] | Sample |
|---|---|---|
| `name` | Name of event | `"Sample live | 100km Duathlon"` |
| `location` | Location | `"🇩🇪 Dresden"` |
| `startTime` | Start time in UTC | `"2022-03-09T07:00:03.201Z"` |
| `endTime` | End time in UTC | `"2022-03-09T14:59:38.201Z"` |
| `timekeepings` | Array for checkpoint objects | |
| `starters` | Array for participant objects | |

#### Checkpoint object
| Field | Description | Sample |
|---|---|---|
| `name` | Name of virtual timekeeping point | `"Split 5"` |
| `offset` | Distance [m] along the shadowtrack | `49222.81` |
| `id` | Unique Racemap ID of timekeeping point | `"6450e60747adaed475b48"` |
| `position` | Array with longitude, latitude, hight [m] | `13.881129999, 51.075250000, 250` |
```
Tokens:
Raw