Overview

This documentation describes how to fetch your data from CC Athletics database through REST API endpoints.

Quick Start:
  1. Get an API key from your Cloud dashboard (Account → API Keys)
  2. Include the API key in the X-API-Key header for all requests
  3. Use the endpoints below to retrieve your data

Base URL

https://europe-west1-forcemate-desktop.cloudfunctions.net

Authentication

API Key

  • Each API request requires a valid API key
  • Include the API key in the X-API-Key header
  • API keys can be generated and managed in your ForceMate Cloud dashboard under Account → API Keys

Example Authentication

curl https://europe-west1-forcemate-desktop.cloudfunctions.net/get_athletes \
  -H "X-API-Key: fm_your_api_key_here"
Security Note: Never share your API key publicly or commit it to version control. Treat it as you would a password.

API Endpoints

GET /get_teams

Description: Retrieve all teams for your organization

Request Example

curl https://europe-west1-forcemate-desktop.cloudfunctions.net/get_teams \
  -H "X-API-Key: fm_your_api_key_here"

Response Format

Loading...
GET /get_athletes

Description: Retrieve athletes including all recordings (optionally filtered by team and other parameters)

Query Parameters

Parameter Type Required Description
team_id string Optional Filter athletes by specific team
min_birth_year integer Optional Filter athletes born on or after this year (e.g., 1990)
max_birth_year integer Optional Filter athletes born on or before this year (e.g., 2005)
tests_date_from string Optional Filter tests recorded on or after this date. Format: YYYY-MM-DD (e.g., 2024-01-01)
tests_date_to string Optional Filter tests recorded on or before this date. Format: YYYY-MM-DD (e.g., 2024-12-31)
analysis_type string Optional Filter by type of analysis. Valid values: "jump", "pogo", "isometric"
jump_types string Optional Comma-separated list of jump types to include. Only applies when analysis_type is "jump" (e.g., "cmj,sj,dj")
isometric_exercise_names string Optional Comma-separated list of isometric exercise names to include. Only applies when analysis_type is "isometric" (e.g., "Mid-thigh pull,Squat")

Request Examples

Basic request (all athletes):

curl https://europe-west1-forcemate-desktop.cloudfunctions.net/get_athletes \
  -H "X-API-Key: fm_your_api_key_here"

Filter by team:

curl "https://europe-west1-forcemate-desktop.cloudfunctions.net/get_athletes?team_id=team_123" \
  -H "X-API-Key: fm_your_api_key_here"

Filter by birth year and test dates:

curl "https://europe-west1-forcemate-desktop.cloudfunctions.net/get_athletes?min_birth_year=1995&max_birth_year=2005&tests_date_from=2024-01-01&tests_date_to=2024-12-31" \
  -H "X-API-Key: fm_your_api_key_here"

Filter by analysis type (jump tests only):

curl "https://europe-west1-forcemate-desktop.cloudfunctions.net/get_athletes?analysis_type=jump" \
  -H "X-API-Key: fm_your_api_key_here"

Filter by specific jump types (CMJ and SJ only):

curl "https://europe-west1-forcemate-desktop.cloudfunctions.net/get_athletes?analysis_type=jump&jump_types=cmj,sj" \
  -H "X-API-Key: fm_your_api_key_here"

Filter isometric exercises:

curl "https://europe-west1-forcemate-desktop.cloudfunctions.net/get_athletes?analysis_type=isometric&isometric_exercise_names=Mid-thigh%20pull,Squat" \
  -H "X-API-Key: fm_your_api_key_here"

Response Format - Basic Structure

Loading...

Complete Response with Jump Recording

Loading...
{ "athletes": [ { "id": "-Nshu6RSt9TGGzm_CPFT", "name": "Johannes Sømod", "team_id": "asdf", "player_info": { "birth_date": 889311600000, "gender": "male", "height_cm": 190, "weight_kg": 93 }, "recordings": [ { "id": "-O4pzO4AYQZ4U85Uagix", "date": 1724261435596, "device_type": "PLATE_DEVICE", "sample_rate": 960, "channel_amount": 2, "firmware_version": "1.5.0", "forcemate_version": "1.9.7", "team_name": "OGF", "comment": "", "injured": false, "full_file_storage_path": "organisations/ioagsodgij/athletes/-Nshu6RSt9TGGzm_CPFT/jump_recordings/2024_08_21-19_30_35.csv", "jump_analysis": [ { "selected_by_user": true, "path_to_this_jump_raw_csv": "organisations/ioagsodgij/athletes/-Nshu6RSt9TGGzm_CPFT/single_jumps_raw_data/2024_11_20-19_37_37_0.csv", "plot_annotations": { "body_mass": 94.5, "jump_type": "cmj", "leg_stance": "dual_leg", "landing_time": 13.361, "takeoff_time": 12.714 }, "metric_table": { "jump_height_ft": 0.513, "peak_force": 2301.65, "takeoff_velocity": 3.174, "contact_time": 1.170, "flight_time": 0.661, "peak_power": 6656.72, "avg_propulsive_force": 2063.48, "avg_braking_force": 1503.56, "rsi_modified": 0.442 // ... 30+ more metrics available } } ] } ] } ], "total": 1 }