OpenGolf API

https://opengolfapi.org/docs
Admin
OpenGolf API is an open REST API and data standard for golf applications, offering course data,...
Tokens:17,262
Snippets:213
Trust Score:6
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### OpenGolf quickstart: sign in, read course, score game

Source: https://opengolfapi.org/docs

Three-step quickstart: sign in with OpenGolf using the SignInWithOpenGolf component, read a course via a keyless GET request, and score a game with a keyless POST to the OpenMatch compute endpoint. The first step requires installing @opengolfapi/sign-in; the curl commands need no API key.

```jsx
# 1 · identity — one component (npm i @opengolfapi/sign-in)
<SignInWithOpenGolf clientId="my-app" redirectUri="https://my.app/callback" />
```

```bash
# 2 · read a course (no key)
curl "https://api.opengolfapi.org/v1/courses/search?q=pebble"
```

```bash
# 3 · score a game (no key)
curl -X POST "https://api.opengolfapi.org/api/v1/compute/skins" -d '{…card…}'
```

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

### GET /api/v1/toolkit/quickstart

Source: https://opengolfapi.org/docs

The all-in-one build recipe (identity→corpus→score→contribute→chain). This endpoint provides a quickstart guide for building on the platform.

```APIDOC
## GET /api/v1/toolkit/quickstart

### Description
The all-in-one build recipe (identity→corpus→score→contribute→chain).

### Method
GET

### Endpoint
/api/v1/toolkit/quickstart

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /llms.txt

Source: https://opengolfapi.org/docs

AI-facing usage guide (llmstxt.org). This endpoint provides an AI-facing usage guide.

```APIDOC
## GET /llms.txt

### Description
AI-facing usage guide (llmstxt.org).

### Method
GET

### Endpoint
/llms.txt

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/beta

Source: https://opengolfapi.org/docs

Get raw local course knowledge. This is a beta endpoint and requires a free API key (X-API-Key or Bearer).

```APIDOC
## GET /api/v1/beta

### Description
Raw local course knowledge (beta).

### Method
GET

### Endpoint
/api/v1/beta

```

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

### Quickstart: keyless curl commands for course search, scoring, and capabilities

Source: https://opengolfapi.org/docs

Keyless quickstart commands: search courses, score a game with gross scoring, and list all API capabilities. No authentication is required for reads or gross scoring.

```bash
curl "https://api.opengolfapi.org/v1/courses/search?q=pebble"
```

```bash
curl -X POST "https://api.opengolfapi.org/api/v1/compute/skins" \
  -H "content-type: application/json" \
  -d '{"players":[{"player_id":"a","holes":{"1":4,"2":5}}],"holes":[{"hole":1,"par":4},{"hole":2,"par":5}]}'
```

```bash
curl "https://api.opengolfapi.org/api/v1/capabilities"
```

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

### GET /api/v1/courses/{id}/conditions

Source: https://opengolfapi.org/docs

Get live playing conditions for a specific course. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/{id}/conditions

### Description
Live conditions at a course (free).

### Method
GET

### Endpoint
/api/v1/courses/{id}/conditions

### Parameters
#### Path Parameters
- **id** (string) - Required - The course ID.

```

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

### GET /api/v1/developer/keys

Source: https://opengolfapi.org/docs

List your developer keys. Requires X-OpenGolf-Token for authentication.

```APIDOC
## GET /api/v1/developer/keys

### Description
List your keys (X-OpenGolf-Token).

### Method
GET

### Endpoint
/api/v1/developer/keys

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/courses/{id}/daylight

Source: https://opengolfapi.org/docs

Get sunrise/sunset times and optimal tee windows for a specific course. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/{id}/daylight

### Description
Sunrise/sunset & optimal tee windows.

### Method
GET

### Endpoint
/api/v1/courses/{id}/daylight

### Parameters
#### Path Parameters
- **id** (string) - Required - The course ID.

```

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

### GET /api/v1/courses/{id}/weather

Source: https://opengolfapi.org/docs

Get the live weather forecast for a specific course. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/{id}/weather

### Description
Live weather forecast.

### Method
GET

### Endpoint
/api/v1/courses/{id}/weather

### Parameters
#### Path Parameters
- **id** (string) - Required - The course ID.

```

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

### GET /api/v1/toolkit/built-with

Source: https://opengolfapi.org/docs

The "Built with OpenGolf" showcase. This endpoint provides a showcase of apps built with OpenGolf.

```APIDOC
## GET /api/v1/toolkit/built-with

### Description
The "Built with OpenGolf" showcase.

### Method
GET

### Endpoint
/api/v1/toolkit/built-with

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/claims/{id}

Source: https://opengolfapi.org/docs

Get a claim and its associated evidence. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/claims/{id}

### Description
A claim + its evidence.

### Method
GET

### Endpoint
/api/v1/claims/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The claim ID.

```

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

### GET /api/v1/courses/{id}/pricing

Source: https://opengolfapi.org/docs

Get the latest green-fee pricing for a specific course. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/{id}/pricing

### Description
Latest green-fee pricing.

### Method
GET

### Endpoint
/api/v1/courses/{id}/pricing

### Parameters
#### Path Parameters
- **id** (string) - Required - The course ID.

```

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

### GET /api/v1/competitions/{id}

Source: https://opengolfapi.org/docs

Get a competition and its live gross result. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/competitions/{id}

### Description
Competition + live gross Result.

### Method
GET

### Endpoint
/api/v1/competitions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The competition ID.

```

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

### GET /api/v1/orgs

Source: https://opengolfapi.org/docs

Get a public directory of verified organizations. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/orgs

### Description
Public directory of verified organizations.

### Method
GET

### Endpoint
/api/v1/orgs

```

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

### GET /api/v1/assets/{id}

Source: https://opengolfapi.org/docs

Get a single asset by its ID. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/assets/{id}

### Description
One asset.

### Method
GET

### Endpoint
/api/v1/assets/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The asset ID.

```

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

### GET /api/v1/toolkit/playground

Source: https://opengolfapi.org/docs

Copy-paste recipes for the free surface. This endpoint provides copy-paste recipes for using the free surface of the API.

```APIDOC
## GET /api/v1/toolkit/playground

### Description
Copy-paste recipes for the free surface.

### Method
GET

### Endpoint
/api/v1/toolkit/playground

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/orgs/{id}

Source: https://opengolfapi.org/docs

Get the public profile of a verified organization. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/orgs/{id}

### Description
A verified org public profile.

### Method
GET

### Endpoint
/api/v1/orgs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The organization ID.

```

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

### GET /

Source: https://opengolfapi.org/docs

Service info & endpoint list. This endpoint returns general service information and a list of available endpoints.

```APIDOC
## GET /

### Description
Service info & endpoint list.

### Method
GET

### Endpoint
/

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/courses/{id}/climate

Source: https://opengolfapi.org/docs

Get seasonality and best months to play for a specific course. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/{id}/climate

### Description
Seasonality & best months.

### Method
GET

### Endpoint
/api/v1/courses/{id}/climate

### Parameters
#### Path Parameters
- **id** (string) - Required - The course ID.

```

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

### GET /api/v1/toolkit/playground.html

Source: https://opengolfapi.org/docs

Interactive browser playground. This endpoint provides an interactive browser playground for testing the API.

```APIDOC
## GET /api/v1/toolkit/playground.html

### Description
Interactive browser playground.

### Method
GET

### Endpoint
/api/v1/toolkit/playground.html

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/assets

Source: https://opengolfapi.org/docs

Get the unified trophy case including assets and legacy award trophies. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/assets

### Description
Trophy case — assets + legacy award trophies, unified.

### Method
GET

### Endpoint
/api/v1/assets

```

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

### GET /api/v1/competitions

Source: https://opengolfapi.org/docs

List all competitions. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/competitions

### Description
List competitions.

### Method
GET

### Endpoint
/api/v1/competitions

```

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

### GET /api/v1/courses/{id}/tees

Source: https://opengolfapi.org/docs

Get tee ratings for a specific course. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/{id}/tees

### Description
Tee ratings.

### Method
GET

### Endpoint
/api/v1/courses/{id}/tees

### Parameters
#### Path Parameters
- **id** (string) - Required - The course ID.

```

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

### GET /api/v1/entitlements

Source: https://opengolfapi.org/docs

List your entitlements. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## GET /api/v1/entitlements

### Description
List your entitlements.

### Method
GET

### Endpoint
/api/v1/entitlements

```

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

### GET /openapi.json

Source: https://opengolfapi.org/docs

This OpenAPI spec. This endpoint returns the OpenAPI specification for the API.

```APIDOC
## GET /openapi.json

### Description
This OpenAPI spec.

### Method
GET

### Endpoint
/openapi.json

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/competitions/{id}/results

Source: https://opengolfapi.org/docs

Get the immutable result lineage for a competition. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/competitions/{id}/results

### Description
The immutable Result lineage (free).

### Method
GET

### Endpoint
/api/v1/competitions/{id}/results

### Parameters
#### Path Parameters
- **id** (string) - Required - The competition ID.

```

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

### GET /.well-known/openid-configuration

Source: https://opengolfapi.org/docs

OIDC discovery document. This endpoint provides the OpenID Connect discovery document.

```APIDOC
## GET /.well-known/openid-configuration

### Description
OIDC discovery document.

### Method
GET

### Endpoint
/.well-known/openid-configuration

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/developer/apps

Source: https://opengolfapi.org/docs

List your registered apps/entities. This endpoint returns a list of applications or entities registered under your OpenGolf ID.

```APIDOC
## GET /api/v1/developer/apps

### Description
List your registered apps/entities.

### Method
GET

### Endpoint
/api/v1/developer/apps

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/primitives

Source: https://opengolfapi.org/docs

The 15-primitive ontology (one vocabulary for the whole platform). This endpoint provides the 15-primitive ontology.

```APIDOC
## GET /api/v1/primitives

### Description
The 15-primitive ontology (one vocabulary for the whole platform).

### Method
GET

### Endpoint
/api/v1/primitives

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/compute

Source: https://opengolfapi.org/docs

List available scoring formats for OpenMatch. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/compute

### Description
List scoring formats.

### Method
GET

### Endpoint
/api/v1/compute

```

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

### GET /api/v1/courses/{id}/nearby

Source: https://opengolfapi.org/docs

Get nearby hotels, restaurants, and other courses for a specific course. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/{id}/nearby

### Description
Nearby hotels, restaurants, courses.

### Method
GET

### Endpoint
/api/v1/courses/{id}/nearby

### Parameters
#### Path Parameters
- **id** (string) - Required - The course ID.

```

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

### GET /api/v1/chain/log

Source: https://opengolfapi.org/docs

Accesses the public append-only transparency log.

```APIDOC
## GET /api/v1/chain/log

### Description
The public append-only transparency log.

### Method
GET

### Endpoint
/api/v1/chain/log

### Response
#### Success Response (200)
- **entries** (array of objects) - Log entries (format not specified in source)

```

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

### GET /api/v1/courses/{id}/holes/{num}

Source: https://opengolfapi.org/docs

Get detailed information for a single hole on a specific course. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/{id}/holes/{num}

### Description
Single hole detail.

### Method
GET

### Endpoint
/api/v1/courses/{id}/holes/{num}

### Parameters
#### Path Parameters
- **id** (string) - Required - The course ID.
- **num** (integer) - Required - The hole number.

```

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

### GET /api/v1/courses/{id}/difficulty

Source: https://opengolfapi.org/docs

Get the difficulty percentile of a course compared to nearby courses. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/{id}/difficulty

### Description
Difficulty percentile vs nearby.

### Method
GET

### Endpoint
/api/v1/courses/{id}/difficulty

### Parameters
#### Path Parameters
- **id** (string) - Required - The course ID.

```

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

### GET /api/v1/chain/anchors/{id}

Source: https://opengolfapi.org/docs

Resolves a record's anchor to its checkpoint and Bitcoin proof.

```APIDOC
## GET /api/v1/chain/anchors/{id}

### Description
Resolve a record's anchor → its checkpoint + Bitcoin proof.

### Method
GET

### Endpoint
/api/v1/chain/anchors/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Anchor identifier

### Response
#### Success Response (200)
- **anchor** (string) - Record anchor
- **checkpoint** (string) - Checkpoint associated with the anchor
- **bitcoinProof** (string) - Bitcoin proof of the checkpoint

```

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

### GET /api/v1/me

Source: https://opengolfapi.org/docs

Export your own contributed data. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## GET /api/v1/me

### Description
Export your own contributed data.

### Method
GET

### Endpoint
/api/v1/me

```

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

### GET /api/v1/courses/bulk

Source: https://opengolfapi.org/docs

Fetch multiple courses in a single request by providing course IDs. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/bulk

### Description
Batch fetch courses by id.

### Method
GET

### Endpoint
/api/v1/courses/bulk

```

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

### GET /adapters/langchain.json

Source: https://opengolfapi.org/docs

LangChain tool manifest (generated from this spec). This endpoint provides a LangChain tool manifest.

```APIDOC
## GET /adapters/langchain.json

### Description
LangChain tool manifest (generated from this spec).

### Method
GET

### Endpoint
/adapters/langchain.json

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/courses/{id}/holes

Source: https://opengolfapi.org/docs

Get hole information including hazards for a specific course. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/{id}/holes

### Description
Holes with hazards.

### Method
GET

### Endpoint
/api/v1/courses/{id}/holes

### Parameters
#### Path Parameters
- **id** (string) - Required - The course ID.

```

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

### GET /api/v1/chain/anchors/{id}/inclusion

Source: https://opengolfapi.org/docs

Provides the Merkle inclusion proof that the record is under the anchored root.

```APIDOC
## GET /api/v1/chain/anchors/{id}/inclusion

### Description
Merkle inclusion proof: your record is under the anchored root.

### Method
GET

### Endpoint
/api/v1/chain/anchors/{id}/inclusion

### Parameters
#### Path Parameters
- **id** (string) - Required - Anchor identifier

### Response
#### Success Response (200)
- **proof** (array of objects) - Merkle proof nodes
- **root** (string) - The anchored Merkle root

```

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

### GET /api/v1/openshot/fields

Source: https://opengolfapi.org/docs

OpenShot field catalog (what to send). This endpoint provides the field catalog for OpenShot.

```APIDOC
## GET /api/v1/openshot/fields

### Description
OpenShot field catalog (what to send).

### Method
GET

### Endpoint
/api/v1/openshot/fields

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/claims

Source: https://opengolfapi.org/docs

List claims from the trust ledger. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/claims

### Description
List claims (trust ledger).

### Method
GET

### Endpoint
/api/v1/claims

```

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

### GET /api/v1/webhooks

Source: https://opengolfapi.org/docs

List your active subscriptions. This endpoint lists your active webhook subscriptions.

```APIDOC
## GET /api/v1/webhooks

### Description
List your active subscriptions.

### Method
GET

### Endpoint
/api/v1/webhooks

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /adapters/zapier.json

Source: https://opengolfapi.org/docs

Zapier app definition (generated from this spec + events). This endpoint provides a Zapier app definition.

```APIDOC
## GET /adapters/zapier.json

### Description
Zapier app definition (generated from this spec + events).

### Method
GET

### Endpoint
/adapters/zapier.json

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /asyncapi.json

Source: https://opengolfapi.org/docs

AsyncAPI 3.0 doc for the webhook event stream. This endpoint provides the AsyncAPI documentation for the webhook event stream.

```APIDOC
## GET /asyncapi.json

### Description
AsyncAPI 3.0 doc for the webhook event stream.

### Method
GET

### Endpoint
/asyncapi.json

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/moments

Source: https://opengolfapi.org/docs

Read your own moments. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## GET /api/v1/moments

### Description
Read your own moments.

### Method
GET

### Endpoint
/api/v1/moments

```

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

### GET /api/v1/events/{id}

Source: https://opengolfapi.org/docs

Event config + status. This endpoint retrieves the configuration and status of an event.

```APIDOC
## GET /api/v1/events/{id}

### Description
Event config + status.

### Method
GET

### Endpoint
/api/v1/events/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The event ID.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/me/chain

Source: https://opengolfapi.org/docs

Export your OpenGolf Chain, a verifiable self-sovereign record. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## GET /api/v1/me/chain

### Description
Export your OpenGolf Chain (verifiable self-sovereign record).

### Method
GET

### Endpoint
/api/v1/me/chain

```

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

### GET /api/v1/capabilities

Source: https://opengolfapi.org/docs

Generated map of the open platform (always current). This endpoint provides a generated map of the open platform's capabilities.

```APIDOC
## GET /api/v1/capabilities

### Description
Generated map of the open platform (always current).

### Method
GET

### Endpoint
/api/v1/capabilities

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/join/profile/{id}

Source: https://opengolfapi.org/docs

Read a profile (keyed — identity-scoped). This endpoint reads a profile by ID, scoped to the identity.

```APIDOC
## GET /api/v1/join/profile/{id}

### Description
Read a profile (keyed — identity-scoped).

### Method
GET

### Endpoint
/api/v1/join/profile/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The profile ID.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/sessions/{id}/leaderboard

Source: https://opengolfapi.org/docs

Gross or net leaderboard for a session (?format=gross|net). This endpoint returns a gross or net leaderboard for a session.

```APIDOC
## GET /api/v1/sessions/{id}/leaderboard

### Description
Gross or net leaderboard for a session (?format=gross|net).

### Method
GET

### Endpoint
/api/v1/sessions/{id}/leaderboard

### Parameters
#### Path Parameters
- **id** (string) - Required - The session ID.

#### Query Parameters
- **format** (string) - Optional - The format of the leaderboard: gross or net.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/courses/{id}

Source: https://opengolfapi.org/docs

Retrieve full details for a specific golf course. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/{id}

### Description
Full free course detail.

### Method
GET

### Endpoint
/api/v1/courses/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The course ID.

```

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

### GET /api/v1/toolkit/badge

Source: https://opengolfapi.org/docs

"Built on OpenGolf" SVG badge. This endpoint returns an SVG badge for apps built on OpenGolf.

```APIDOC
## GET /api/v1/toolkit/badge

### Description
"Built on OpenGolf" SVG badge.

### Method
GET

### Endpoint
/api/v1/toolkit/badge

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/shots

Source: https://opengolfapi.org/docs

Read your own shot history. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## GET /api/v1/shots

### Description
Read your own shot history.

### Method
GET

### Endpoint
/api/v1/shots

```

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

### GET /api/v1/courses/architect/{name}

Source: https://opengolfapi.org/docs

Find golf courses designed by a specific architect. The architect name is matched fuzzily.

```APIDOC
## GET /api/v1/courses/architect/{name}

### Description
Courses by architect (fuzzy).

### Method
GET

### Endpoint
/api/v1/courses/architect/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The architect's name (fuzzy match).

```

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

### GET /api/v1/stream/replay

Source: https://opengolfapi.org/docs

Replay your domain events after a cursor (owner-scoped; seq cursor). This endpoint replays domain events after a given cursor.

```APIDOC
## GET /api/v1/stream/replay

### Description
Replay your domain events after a cursor (owner-scoped; seq cursor).

### Method
GET

### Endpoint
/api/v1/stream/replay

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/stats

Source: https://opengolfapi.org/docs

Live dataset stats (course counts). This endpoint provides live statistics about the dataset, such as course counts.

```APIDOC
## GET /api/v1/stats

### Description
Live dataset stats (course counts).

### Method
GET

### Endpoint
/api/v1/stats

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/sessions/{id}/synthesize

Source: https://opengolfapi.org/docs

live_state — composed realtime view (?include=leaderboard,sidegames,presence,pace,highlights). This endpoint provides a composed realtime view of a session.

```APIDOC
## GET /api/v1/sessions/{id}/synthesize

### Description
live_state — composed realtime view (?include=leaderboard,sidegames,presence,pace,highlights).

### Method
GET

### Endpoint
/api/v1/sessions/{id}/synthesize

### Parameters
#### Path Parameters
- **id** (string) - Required - The session ID.

#### Query Parameters
- **include** (string) - Optional - Comma-separated list of components to include: leaderboard, sidegames, presence, pace, highlights.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### POST /api/v1/toolkit/built-with

Source: https://opengolfapi.org/docs

Register your application in the OpenGolfAPI showcase. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## POST /api/v1/toolkit/built-with

### Description
Register your app in the showcase.

### Method
POST

### Endpoint
/api/v1/toolkit/built-with

```

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

### GET /api/v1/moments/fields

Source: https://opengolfapi.org/docs

Moments field catalog (any sensor → one event). This endpoint provides the field catalog for moments.

```APIDOC
## GET /api/v1/moments/fields

### Description
Moments field catalog (any sensor → one event).

### Method
GET

### Endpoint
/api/v1/moments/fields

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/features

Source: https://opengolfapi.org/docs

Course features (greens/bunkers/water polygons). Free = coarse OSM; precise detected layer is gated. This endpoint returns course features.

```APIDOC
## GET /api/v1/features

### Description
Course features (greens/bunkers/water polygons). Free = coarse OSM; precise detected layer is gated.

### Method
GET

### Endpoint
/api/v1/features

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### POST /api/v1/courses

Source: https://opengolfapi.org/docs

Create a new blank-canvas course using a name and GPS coordinates. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## POST /api/v1/courses

### Description
Create a new (blank-canvas) course from name + GPS.

### Method
POST

### Endpoint
/api/v1/courses

```

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

### GET /api/v1/ontology

Source: https://opengolfapi.org/docs

THE ONTOLOGY — all 42 moment types, payload schemas, broadcast kinds, icon vocabulary (free, CC0). This endpoint provides the full ontology of the platform.

```APIDOC
## GET /api/v1/ontology

### Description
THE ONTOLOGY — all 42 moment types, payload schemas, broadcast kinds, icon vocabulary (free, CC0).

### Method
GET

### Endpoint
/api/v1/ontology

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/join/beacons

Source: https://opengolfapi.org/docs

Find active beacons near a course (consented presence only). This endpoint finds active presence beacons near a course.

```APIDOC
## GET /api/v1/join/beacons

### Description
Find active beacons near a course (consented presence only).

### Method
GET

### Endpoint
/api/v1/join/beacons

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/courses/state/{code}

Source: https://opengolfapi.org/docs

Retrieve all golf courses located in a specified US state. The state code is provided as a path parameter.

```APIDOC
## GET /api/v1/courses/state/{code}

### Description
All courses in a US state.

### Method
GET

### Endpoint
/api/v1/courses/state/{code}

### Parameters
#### Path Parameters
- **code** (string) - Required - The US state code.

```

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

### GET /api/v1/players/{id}/handicap

Source: https://opengolfapi.org/docs

OpenIndex (beta) — estimated handicap from notarized rounds (self-sovereign: your own is free). This endpoint returns an estimated handicap for a player.

```APIDOC
## GET /api/v1/players/{id}/handicap

### Description
OpenIndex (beta) — estimated handicap from notarized rounds (self-sovereign: your own is free).

### Method
GET

### Endpoint
/api/v1/players/{id}/handicap

### Parameters
#### Path Parameters
- **id** (string) - Required - The player ID.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### POST /api/v1/join/login

Source: https://opengolfapi.org/docs

Sign in with OpenGolf (hosted): start/complete the verified-code flow. This endpoint handles the hosted sign-in flow with OpenGolf.

```APIDOC
## POST /api/v1/join/login

### Description
Sign in with OpenGolf (hosted): start/complete the verified-code flow.

### Method
POST

### Endpoint
/api/v1/join/login

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### POST /api/v1/join/beacon

Source: https://opengolfapi.org/docs

Set a presence beacon (opt-in "I am at the course"). This endpoint sets a presence beacon indicating the user is at the course.

```APIDOC
## POST /api/v1/join/beacon

### Description
Set a presence beacon (opt-in "I am at the course").

### Method
POST

### Endpoint
/api/v1/join/beacon

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### GET /api/v1/sessions/{id}/feed

Source: https://opengolfapi.org/docs

OpenBroadcast feed — ONE typed read: broadcast-worthy items, ascending (recorded_at, seq), template narration (60/80 caps), money only when settled. This endpoint provides a broadcast feed for a session.

```APIDOC
## GET /api/v1/sessions/{id}/feed

### Description
OpenBroadcast feed — ONE typed read: broadcast-worthy items, ascending (recorded_at, seq), template narration (60/80 caps), money only when settled.

### Method
GET

### Endpoint
/api/v1/sessions/{id}/feed

### Parameters
#### Path Parameters
- **id** (string) - Required - The session ID.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### POST /api/v1/beta

Source: https://opengolfapi.org/docs

Drop local knowledge. This is a beta endpoint and requires a free API key (X-API-Key or Bearer).

```APIDOC
## POST /api/v1/beta

### Description
Drop local knowledge (beta).

### Method
POST

### Endpoint
/api/v1/beta

```

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

### POST /api/v1/developer/keys/link

Source: https://opengolfapi.org/docs

Confirm your OpenGolf ID on an existing (legacy) key. This endpoint links a legacy developer key to your OpenGolf identity.

```APIDOC
## POST /api/v1/developer/keys/link

### Description
Confirm your OpenGolf ID on an existing (legacy) key.

### Method
POST

### Endpoint
/api/v1/developer/keys/link

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### POST /oauth/start

Source: https://opengolfapi.org/docs

Sign in with OpenGolf — email a 6-digit code. This endpoint initiates the OAuth sign-in flow by sending a verification code to the user's email.

```APIDOC
## POST /oauth/start

### Description
Sign in with OpenGolf — email a 6-digit code.

### Method
POST

### Endpoint
/oauth/start

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### POST /api/v1/me/chain/checkpoint

Source: https://opengolfapi.org/docs

Checkpoint your chain by signing and staging an OpenTimestamps anchor. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## POST /api/v1/me/chain/checkpoint

### Description
Checkpoint your chain (sign + stage OpenTimestamps anchor).

### Method
POST

### Endpoint
/api/v1/me/chain/checkpoint

```

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

### POST /api/v1/assets/mint

Source: https://opengolfapi.org/docs

Mint a new asset to an owner. This endpoint requires an API key with the 'assets:issue' scope.

```APIDOC
## POST /api/v1/assets/mint

### Description
Mint an Asset to an owner (scope assets:issue).

### Method
POST

### Endpoint
/api/v1/assets/mint

```

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

### POST /api/v1/shots

Source: https://opengolfapi.org/docs

Ingest launch-monitor shots into your shot history. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## POST /api/v1/shots

### Description
Ingest launch-monitor shots.

### Method
POST

### Endpoint
/api/v1/shots

```

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

### POST /api/v1/toolkit/convert

Source: https://opengolfapi.org/docs

Scaffold an adapter from your app's endpoints. This endpoint scaffolds an adapter based on your app's endpoints.

```APIDOC
## POST /api/v1/toolkit/convert

### Description
Scaffold an adapter from your app's endpoints.

### Method
POST

### Endpoint
/api/v1/toolkit/convert

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### POST /api/v1/competitions

Source: https://opengolfapi.org/docs

Create a new competition. This endpoint requires an API key.

```APIDOC
## POST /api/v1/competitions

### Description
Create a competition (keyed).

### Method
POST

### Endpoint
/api/v1/competitions

```

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

### GET /api/v1/health

Source: https://opengolfapi.org/docs

Health check. This endpoint provides a health check for the API.

```APIDOC
## GET /api/v1/health

### Description
Health check.

### Method
GET

### Endpoint
/api/v1/health

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### POST /api/v1/me/chain/verify

Source: https://opengolfapi.org/docs

Verify a chain export. This is a public tool and does not require an API key.

```APIDOC
## POST /api/v1/me/chain/verify

### Description
Verify a chain export (public tool, no key).

### Method
POST

### Endpoint
/api/v1/me/chain/verify

```

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

### POST /api/v1/developer/apps

Source: https://opengolfapi.org/docs

Register an app/entity under your OpenGolf ID. This endpoint is used to register a new application or entity.

```APIDOC
## POST /api/v1/developer/apps

### Description
Register an app/entity under your OpenGolf ID.

### Method
POST

### Endpoint
/api/v1/developer/apps

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### POST /api/v1/claims

Source: https://opengolfapi.org/docs

File a new claim. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## POST /api/v1/claims

### Description
File a claim.

### Method
POST

### Endpoint
/api/v1/claims

```

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

### POST /api/v1/moments

Source: https://opengolfapi.org/docs

Ingest Open Connect events as moments. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## POST /api/v1/moments

### Description
Ingest Open Connect events.

### Method
POST

### Endpoint
/api/v1/moments

```

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

### POST /api/v1/import

Source: https://opengolfapi.org/docs

Import a round export in GPX, CSV, or JSON format and convert it into moments. This endpoint requires a free API key (X-API-Key or Bearer).

```APIDOC
## POST /api/v1/import

### Description
Import a round export (GPX/CSV/JSON) → moments.

### Method
POST

### Endpoint
/api/v1/import

```

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

### POST /api/v1/developer/keys

Source: https://opengolfapi.org/docs

Mint a developer key bound to your OpenGolf ID. This endpoint is used to create a new developer key for accessing the API.

```APIDOC
## POST /api/v1/developer/keys

### Description
Mint a dev key bound to your OpenGolf ID.

### Method
POST

### Endpoint
/api/v1/developer/keys

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example documented.
```

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

### POST /api/v1/compute/{format}

Source: https://opengolfapi.org/docs

Score a game using the specified scoring format. This endpoint is free and does not require an API key.

```APIDOC
## POST /api/v1/compute/{format}

### Description
Score a game (GROSS) — free & keyless.

### Method
POST

### Endpoint
/api/v1/compute/{format}

### Parameters
#### Path Parameters
- **format** (string) - Required - The scoring format.

```

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

### POST /api/v1/compute/plays_like

Source: https://opengolfapi.org/docs

Calculate the effective distance ("plays like") for a shot. This endpoint is free and does not require an API key.

```APIDOC
## POST /api/v1/compute/plays_like

### Description
Effective distance ("plays like") — free & keyless.

### Method
POST

### Endpoint
/api/v1/compute/plays_like

```

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

### POST /api/v1/competitions/{id}/attempt

Source: https://opengolfapi.org/docs

Record an attempt for a competition. This endpoint requires an API key.

```APIDOC
## POST /api/v1/competitions/{id}/attempt

### Description
Record an Attempt (keyed).

### Method
POST

### Endpoint
/api/v1/competitions/{id}/attempt

### Parameters
#### Path Parameters
- **id** (string) - Required - The competition ID.

```

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

### GET /api/v1/courses/search

Source: https://opengolfapi.org/docs

Search for golf courses by name, state, or location. This endpoint is free and does not require an API key.

```APIDOC
## GET /api/v1/courses/search

### Description
Search courses by name, state, or location.

### Method
GET

### Endpoint
/api/v1/courses/search

```
Tokens:
Raw