---
canonical_url: "https://docs.composio.dev/toolkits/beach_day_api"
markdown_url: "https://docs.composio.dev/toolkits/beach_day_api.md"
product: "platform"
version: null
last_updated: null
---

# Beach Day API

Beach Day API provides beach search, conditions, scores, rules, amenities, tide predictions, and country coverage data.

- **Category:** lifestyle & entertainment
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `BEACH_DAY_API`
- **Version:** 00000000_00

## Tools

### Get Beach Amenities

**Slug:** `BEACH_DAY_API_GET_BEACH_AMENITIES`

Get facilities and accessibility amenities for a beach without paying for the full beach profile. Costs 2 API credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `beach_id` | integer | Yes | Beach ID returned by Search Beaches. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Beach Details

**Slug:** `BEACH_DAY_API_GET_BEACH_DETAILS`

Get a full beach profile, including current score, water quality, weather, ocean conditions, rules, and amenities. Costs 5 API credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `beach_id` | integer | Yes | Beach ID returned by Search Beaches. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Beach Rules

**Slug:** `BEACH_DAY_API_GET_BEACH_RULES`

Get activity rules for a beach without paying for the full beach profile. Costs 2 API credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `beach_id` | integer | Yes | Beach ID returned by Search Beaches. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tide Predictions

**Slug:** `BEACH_DAY_API_GET_TIDE_PREDICTIONS`

Get up to seven days of stored tide-prediction groups for a beach. The provider does not publish this endpoint's credit cost.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `beach_id` | integer | Yes | Beach ID returned by Search Beaches. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Beach Conditions

**Slug:** `BEACH_DAY_API_LIST_BEACH_CONDITIONS`

Return current and recent condition snapshots for a beach, including score, water quality, weather, ocean conditions, and available tide data. Costs 3 API credits per page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum condition snapshots to return in this page (1-200). |
| `offset` | integer | No | Zero-based index of the first condition snapshot to return. Omit for the first page, then pass the previous response's next_offset (repeating the same beach_id and limit) to get the next page. |
| `beach_id` | integer | Yes | Beach ID returned by Search Beaches. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Beaches by Score

**Slug:** `BEACH_DAY_API_LIST_BEACHES_BY_SCORE`

Return beaches ranked by current Beach Day Score from highest to lowest. Costs 10 API credits per page; use only when ranking is needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum ranked beaches to return in this page (1-200). |
| `offset` | integer | No | Zero-based index of the first ranked beach to return. Omit for the first page, then pass the previous response's next_offset (repeating the same limit) to get the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Countries

**Slug:** `BEACH_DAY_API_LIST_COUNTRIES`

List countries covered by Beach Day API with beach counts, ordered from highest to lowest count. Costs 1 API credit.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Beaches

**Slug:** `BEACH_DAY_API_SEARCH_BEACHES`

Find beaches by name, country, or state/province code and return IDs for detail, conditions, rules, amenities, and tide lookups. Costs 1 API credit per page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum beaches to return in this page (1-500). |
| `state` | string | No | State or province code, such as CA, AU-NSW, ES-AN, or BR-RJ. |
| `offset` | integer | No | Zero-based index of the first beach to return. Omit for the first page, then pass the previous response's next_offset (repeating the same search, country, state, and limit) to get the next page. |
| `search` | string | No | Case-insensitive beach-name search term, such as Malibu. |
| `country` | string | No | Case-insensitive country name, such as United States or New Zealand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |