Skip to content
Alex Justesen edited this page Feb 24, 2025 · 7 revisions

Working on coverage for the existing v1 API documented here https://www.openbrewerydb.org/documentation.

About

Returns information on the API including count of breweries in the database and the last time the dataset was updated.

Request type: get

https://obdb-api.alexjustesen.com/about

Get brewery

Request type: get

https://obdb-api.alexjustesen.com/v1/breweries/{id}

List breweries

Request type: get

https://obdb-api.alexjustesen.com/v1/breweries

Parameters

  • page
  • per_page - default 50, max 500

Filter

  • Fields: id, name, city, province, country, postal_code, type
https://obdb-api.alexjustesen.com/v1/breweries?filter[province]=Connecticut&filter[city]=Hartford

Sort

Default sort order is asc, to use desc append a - to the field: example -name.

  • Default: name
  • Fields: id, name, city, province, country, postal_code, type
https://obdb-api.alexjustesen.com/v1/breweries?sort=province&sort=city

Random brewery

Request type: get

https://obdb-api.alexjustesen.com/v1/breweries/random

Search

  • Query string parameter should be url encoded.

Request type: get

https://obdb-api.alexjustesen.com/v1/breweries/search?query=Broad%20Brook

Autocomplete

⚠️ The /autocomplete endpoint was removed as it is essentially a duplicate of /search just with less fields.

Clone this wiki locally