getEveryBrewery: Get All Breweries

Description Usage Arguments Value

Description

Gets a listing of all breweries. Results will be paginated. One of the following attributes must be set: name, established

Usage

1
2
3
getEveryBrewery(p, name, ids, established, isOrganic, hasImages, since,
  status, order, sort, randomCount, withSocialAccounts, withGuilds,
  withLocations, withAlternateNames)

Arguments

p

Page Number

name

Name of a brewery.

ids

ID's of the breweries to return, comma separated. Max 10.

established

Year a brewery was established. Format YYYY

isOrganic

Is the brewery an Organic brewery Y N Default

hasImages

Whether the brewery has an image or not Y N

since

Returns everything that has been updated since that date. Max 30 days. In UNIX timestamp format.

status

Status of the brewery in the API

order

How the results should be ordered name Default description website established mailingListUrl isOrganic status createDate updateDate random

sort

How the results should be sorted. ASC Default DESC

randomCount

If the order parameter is set to random, this option specifies how many random breweries to return. It has a max value of 10

withSocialAccounts

Get brewery results with social account information included. Y N Default

withGuilds

Get brewery results with guild information included. Y N Default

withLocations

Get brewery results with location information included. Y N Default

withAlternateNames

Get brewery results with alternate name information included. Y N Default

Value

id The unique id of the brewery.

name The name of the brewery.

nameShortDisplay The short name of the brewery.

isVerified Wheather or not the brewery has been claimed.

description The description of the brewery.

website The URL to the brewery's website

established The year that the brewery was established.

mailingListUrl The url to the brewery's mailing list.

isOrganic Whether or not the brewery is certified organic.

images The images field will contain the three image sizes for the brewery logos (icon, medium, and large).


samterfa/brewerydb documentation built on June 24, 2019, 12:44 a.m.