Open Brewery DB

https://www.openbrewerydb.org/documentation
Admin
Open Brewery DB is a free API for accessing brewery information with search, filtering, and...
Tokens:1,666
Snippets:5
Trust Score:9.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /v1/breweries/random

Source: https://www.openbrewerydb.org/documentation

Retrieves a random brewery or a list of random breweries.

```APIDOC
## GET /v1/breweries/random

### Description
Get a random brewery. Returns a single brewery object by default, or an array of brewery objects when size is greater than 1.

### Method
GET

### Endpoint
https://api.openbrewerydb.org/v1/breweries/random

### Parameters
#### Query Parameters
- **size** (integer) - No - Number of breweries to return. Default: 1. Maximum: 50.

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the brewery
- **name** (string) - Brewery name
- **brewery_type** (string) - Type of brewery
- **address_1** (string or null) - Primary street address
- **address_2** (string or null) - Secondary address line
- **address_3** (string or null) - Third address line
- **city** (string) - City name
- **state_province** (string) - State or province
- **postal_code** (string) - Postal or ZIP code
- **country** (string) - Country name
- **longitude** (number or null) - Longitude coordinate
- **latitude** (number or null) - Latitude coordinate
- **phone** (string or null) - Contact phone number
- **website_url** (string or null) - Brewery website URL
- **state** (string) - State abbreviation or name (deprecated)
- **street** (string or null) - Street address (deprecated)
```

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

### GET /breweries

Source: https://www.openbrewerydb.org/documentation

Returns a list of breweries with support for filtering, sorting, and pagination.

```APIDOC
## GET /breweries

### Description
Returns a list of breweries. Supports filtering by city, country, name, state, postal code, type, and IDs. Also supports sorting and pagination.

### Method
GET

### Endpoint
https://api.openbrewerydb.org/v1/breweries

### Parameters
#### Query Parameters
- **by_city** (string) - Optional - Filter breweries by city.
- **by_country** (string) - Optional - Filter breweries by country.
- **by_dist** (string) - Optional - Sort results by distance from an origin point (latitude,longitude).
- **by_ids** (string) - Optional - Comma-separated list of brewery IDs.
- **by_name** (string) - Optional - Filter breweries by name.
- **by_state** (string) - Optional - Filter breweries by full state name.
- **by_postal** (string) - Optional - Filter breweries by postal or ZIP code.
- **by_type** (string) - Optional - Filter by brewery type.
- **page** (integer) - Optional - Page number for pagination. Default: 1.
- **per_page** (integer) - Optional - Number of breweries per page. Default: 50. Max: 200.
- **sort** (string) - Optional - Sort results by one or more fields using asc or desc.
```

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

### GET /breweries/{obdb-id}

Source: https://www.openbrewerydb.org/documentation

Retrieves details for a single brewery by its unique identifier.

```APIDOC
## GET /breweries/{obdb-id}

### Description
Get a single brewery by its unique identifier.

### Method
GET

### Endpoint
https://api.openbrewerydb.org/v1/breweries/{obdb-id}

### Parameters
#### Path Parameters
- **obdb-id** (string) - Required - Unique identifier for the brewery

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the brewery
- **name** (string) - Brewery name
- **brewery_type** (string) - Type of brewery
- **address_1** (string or null) - Primary street address
- **address_2** (string or null) - Secondary address line
- **address_3** (string or null) - Third address line
- **city** (string) - City name
- **state_province** (string) - State or province
- **postal_code** (string) - Postal or ZIP code
- **country** (string) - Country name
- **longitude** (number or null) - Longitude coordinate
- **latitude** (number or null) - Latitude coordinate
- **phone** (string or null) - Contact phone number
- **website_url** (string or null) - Brewery website URL
- **state** (string) - State abbreviation or name (deprecated)
- **street** (string or null) - Street address (deprecated)
```

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

### GET /v1/breweries/meta

Source: https://www.openbrewerydb.org/documentation

Retrieves metadata for breweries based on various filter criteria.

```APIDOC
## GET /v1/breweries/meta

### Description
Metadata takes the same filters as List Breweries.

### Method
GET

### Endpoint
https://api.openbrewerydb.org/v1/breweries/meta

### Parameters
#### Query Parameters
- **by_city** (string) - No - Filter breweries by city.
- **by_country** (string) - No - Filter breweries by country.
- **by_dist** (string) - No - Sort results by distance from an origin point (latitude,longitude).
- **by_ids** (string) - No - Comma-separated list of brewery IDs.
- **by_name** (string) - No - Filter breweries by name.
- **by_state** (string) - No - Filter breweries by full state name.
- **by_postal** (string) - No - Filter breweries by postal or ZIP code.
- **by_type** (string) - No - Filter by brewery type.
- **page** (integer) - No - Page number for pagination. Default: 1.
- **per_page** (integer) - No - Number of breweries per page. Default: 50. Maximum: 200.
```

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

### GET /v1/breweries/search

Source: https://www.openbrewerydb.org/documentation

Search for breweries based on a search term with partial, case-insensitive matching.

```APIDOC
## GET /v1/breweries/search

### Description
Search for breweries based on a search term. The search performs partial, case-insensitive matching against brewery names.

### Method
GET

### Endpoint
https://api.openbrewerydb.org/v1/breweries/search

### Parameters
#### Query Parameters
- **query** (string) - Yes - Search term to match against brewery names. Supports partial matches.
- **per_page** (integer) - No - Number of results per page. Default: 50. Maximum: 200.
- **page** (integer) - No - Page number for pagination. Default: 1.

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the brewery
- **name** (string) - Brewery name
- **brewery_type** (string) - Type of brewery
- **address_1** (string or null) - Primary street address
- **address_2** (string or null) - Secondary address line
- **address_3** (string or null) - Third address line
- **city** (string) - City name
- **state_province** (string) - State or province
- **postal_code** (string) - Postal or ZIP code
- **country** (string) - Country name
- **longitude** (number or null) - Longitude coordinate
- **latitude** (number or null) - Latitude coordinate
- **phone** (string or null) - Contact phone number
- **website_url** (string or null) - Brewery website URL
- **state** (string) - State abbreviation or name (deprecated)
- **street** (string or null) - Street address (deprecated)
```
Tokens:
Raw