# Foreupsoftware — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Find and book available tee times at golf facilities using the foreUP platform by searching for specific dates, player counts, and hole preferences while comparing pricing and availability. Access booking details, notes, and filter options to plan your perfect round of golf.

**Category:** Sports | **Website:** [foreupsoftware.com/](https://foreupsoftware.com/) | **Docs:** [parse.bot/marketplace/6463fd8b-bab1-4c42-9a97-737ad228c0e0/foreupsoftware-com-api](https://parse.bot/marketplace/6463fd8b-bab1-4c42-9a97-737ad228c0e0/foreupsoftware-com-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-foreupsoftware-com-api-6463fd8b/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_booking_notes

Retrieve any public notes or announcements for a course on a specific date. Returns an empty notes array if no notes exist for the given date and course combination.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `course_id` | string | Yes | The ForeUp course ID (e.g. '20498'). |
| `date` | string | Yes | Date in MM-DD-YYYY format. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-foreupsoftware-com-api-6463fd8b/get_booking_notes \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"course_id":"<string>","date":"<string>"}'
```

### get_filters

Retrieve available filtering criteria (schedules and booking classes) for a specific golf course. Returns schedule IDs and booking class IDs needed for search_tee_times. Returns an empty schedules array for unrecognized course IDs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `course_id` | string | Yes | The ForeUp course ID (e.g. '20498'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-foreupsoftware-com-api-6463fd8b/get_filters \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"course_id":"<string>"}'
```

### search_tee_times

Search for available tee times at a golf course on a given date. Returns time slots with pricing and availability. If schedule_id or booking_class_id are not provided, the first available public schedule and booking class from the course configuration are used automatically. Each tee time includes green fee, cart fee, total price, and available spots.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `booking_class_id` | string | No | Booking class ID from get_filters schedules[*].booking_classes[*].id. If omitted, the first public booking class is used. |
| `course_id` | string | Yes | The ForeUp course ID (e.g. '20498'). |
| `date` | string | Yes | Date for tee times in MM-DD-YYYY or YYYY-MM-DD format. |
| `holes` | string | No | Number of holes filter: '9', '18', or 'all'. |
| `players` | string | No | Number of players. '0' means any number of players. |
| `schedule_id` | string | No | Schedule/tee sheet ID from get_filters schedules[*].id. If omitted, the first schedule is used. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-foreupsoftware-com-api-6463fd8b/search_tee_times \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"booking_class_id":"<string>","course_id":"<string>","date":"<string>","holes":"<string>","players":"<string>","schedule_id":"<string>"}'
```
