API Documentation

About the API

Gain quick and easy access to the most detailed information on bar and club venues across the United States with over 30,000 businesses and growing every day. The documentation outlined below will help you get started on how to find specific venues or search for bars in a geographic area.

We have partnered with the 3Scale API Management Platform where you can register to request an API key and execute sample requests. Get started by clicking here to select your plan.

The barzz API allows you to:

  • Request information on specific venues
  • Receive up to 20 results by location. Search requests can be filtered by specific bar types and amenities.
  • Venue information returned in the response for each bar includes: bar type, amenities, geo-location, current day specials (if available), and much more.

Request Access

An API key can be requested from our secure, dedicated portal at 3Scale: barzz.3scale.net.

Authentication

We use a standard API Key authentication pattern for validating API requests. The name of the API key parameter is user_key.

Rate Limits

We currently limit accounts to 5,000 API calls per day. If you desire additional requests, please contact us at api@barzz.net and include "API" in the subject header.

Business Request

Find information on an individual venue by phone number:

  • /business?phone

Business request by phone parameters:

Name Data Type Required / Optional Description
phone string required Parameter specifying the business phone number

Sample request:

  • https://api.barzz.net/api/business?phone=5555551234

Find information on an individual venue by name and location:

  • /business?name&city
  • /business?name&city&state
  • /business?name&zip

Business request by name and location:

Name Data Type Required / Optional Description
name string required Parameter specifying the name of the business
city string optional Parameter specifying the city where the business is located
state string optional State is an optional parameter that is accepted only when passing the city parameter
zip string optional Parameter specifying the zip code where the business is located

Sample request:

  • https://api.barzz.net/api/business?name=barzz+lounge&zip=01234

Search Request

Search for bars in a geographical area

Sample requests:

  • /search?zip
Name Data Type Required / Optional Description
zip string optional Parameter specifying the zip code of the area. If no limit is specified, the top 20 results are returned in the zip code provided.
city string optional Parameter specifying the city to search
state string optional State is required when passing the city parameter

Additional filters:

Name Data Type Required / Optional Description
type string optional Parameter filtering results that match the specified bar type. See below for a list of allowable bar type values.
amenity string optional Parameter filtering results that match the specified bar amenity. See below for a list of allowable bar amenity values.
limit number optional Parameter specifying the number of results to return. Max is 20.
offset number optional The point in the list of results where you wish to begin. Default is 0. For example, if you wish to see 5 results per page, you can display results on page 2 by passing 5 as Offset with Limit of 5.
specials bool optional Parameter specifying whether to only return bars with specials on the current day. Accepted values are Y (only returns bars with specials data) and N (returns bars whether they have specials data or not). Default is N.

Type and Amenity Filter Options:

Type:

  • Beer, Club, Cocktail, Dive, Lounge, Music Venue, Pub, Restaurant, Singles, Sports, Wine
  • Amenity:

  • 9 TVs (note - will return all venues with 9 or more TVs), Brunch, Dance Floor, Darts, Free WiFi, Full Menu, Karaoke, Outdoor Seating, Pool Table, Private Parties, Rooftop, Video Games
  • Sample request:

    • https://api.barzz.net/api/search?zip=01234&type=lounge&amenity=rooftop

    Response

    Below is the standard response values returned from either a business or search request:

    Name Data Description
    ID Number Unique bar barzz id
    Name String Bar name
    Address String Street address where bar is located
    City String City where bar is located
    State String State where bar is located
    Zip Number Zip code where bar is located
    Latitude Number Latitude coordinate of this location
    Longitude Number Longitude coordinate of this location
    Phone String Phone number of the bar (eg 5555551234)
    Bar_Website Url Website of the bar
    Bar_Url Url URL of bar on the barzz.net website. Please use this value when linking back to the bar's profile on barzz.net
    Hours String Hours of operation for the bar
    Type String The type of bar
    Amenity String Amenities available at the bar
    Bar_Image URL Image of the bar
    Music_Source String Generally one or more of DJ, Live, Jukebox, System
    Music_Type String Type of music that is played at the bar
    Food_Type String Type of food served at the bar
    Dress_Code String General attire of the bar or specific dress code enforcement
    Payment_Options String Payment options accepted by the bar
    Cover_Charge String How much the bar charges for cover
    Parking String Parking options near or at the bar location
    Pro_Sports_Team String Professional sports team(s) played at the bar; generally meant for teams not from the bar's location
    College_Team String College sports team(s) played at the bar; generally meant for teams not from the bar's location
    TV_Packages String Sports TV packages played at the bar
    Special_Drinks String Specialty drink menu; 250 character count limit enforced
    Daily_Specials Number Specials offered by the bar every day; 250 character count limit enforced
    Monday_Specials String Specials offered by the bar on Monday; 250 character count limit enforced
    Tuesday_Specials String Specials offered by the bar on Tuesday; 250 character count limit enforced
    Wednesday_Specials String Specials offered by the bar on Wednesday; 250 character count limit enforced
    Thursday_Specials String Specials offered by the bar on Thursday; 250 character count limit enforced
    Friday_Specials String Specials offered by the bar on Friday; 250 character count limit enforced
    Saturday_Specials String Specials offered by the bar on Saturday; 250 character count limit enforced
    Sunday_Specials String Specials offered by the bar on Sunday; 250 character count limit enforced

    Errors

    Below are standard error codes returned by the barzz API:

    Reason Code Description
    Internal Error 101 Internal server error has occurred
    Authentication Failure 102 The API key provided is invalid
    Maximum Requests Exceeded 103 The number of maximum daily requests has been exceeded
    Required Field Missing 104 A required parameter is missing from the request
    Invalid Value 105 A parameter includes a value that is not valid
    No Results Found 201 No business listing is returned. Pertains to either business or search requests.
    Multiple Results Found 202 Multiple business listings are returned. Pertains to business requests only.
    No Business Information Available 203 Individual business listing is returned but does not contain venue details.
    Invalid Location 204 The location provided could not be found.
    Multiple Locations Found 205 Multiple locations are returned. Pertains to search requests only.
    Search Area Too Large 206 Size of the area requested is too large.

    Display Requirements

    1. The barzz logo must be shown prominently on all content originating from the BARZZ API. Sample images are available in #4 below.

    2. Data must not be stored longer than 24 hours.

    3. The word barzz must always be written in all lowercase.

    4. barzz image - You must show one of the below images next to any barzz content. The image needs to link back to barzz.net and each individual bar must be linked back to the barzz site using the Bar Url from the API Response.

    FAQ

  • 1. How do I obtain an API key?
  • Go to our Sign Up page to register and receive your API key.

  • 2. My API key is not working. What do I do?
  • Please first verify that the API key you are using is the same that was provided to you. If you are still having a problem, email us at api@barzz.net.

  • 3. How man API calls can I make?
  • We allow up to 5,000 calls per day. If you would like additional access, email us at api@barzz.net.

  • 4. Can I apply without a working website or app?
  • You must have a working URL for your website or app to be eligible for the BARZZ API. Once your site is live, you can apply for an API key and begin making requests to the BARZZ API.

  • 5. What is the best way request information on an individual venue?
  • Our business API request by phone number is the best way to match an individual venue.

  • 6. What if no results are returned?
  • For business requests, make sure you are sending the correct phone or location information. We provide several different ways to search for an individual venue.

  • For search requests, make sure you have the correct location information.
  • We only return content when there is sufficient information available for the particular request.
  • 7. What type of information should I expect to receive?
  • The Response section above lists all the available fields returned for a particular venue. Not all bars will have values for every field.

  • 8. Can I store content from the BARZZ API?
  • No. Refer to our API Terms of Use for more information.

  • 9. How much does the API cost?
  • Access to the BARZZ API is FREE for up to 5,000 calls per day.

    Terms of Use

  • API Terms of Use
  • Effective 9/15/16
  • The following terms (the "API Agreement") govern the access and use of BARZZ.Net, Inc.'s ("BARZZ") application programmer interface (the "BARZZ API"), accompanying documentation, and the data transmitted through the BARZZ API ("BARZZ Content"). By accessing and using the BARZZ API, you are consenting to be bound by the terms set forth in this API Agreement and is effective from the date on which you first access the BARZZ API. This document incorporates the terms of the Terms of Use and Privacy Policy documents made available on the barzz.net website and mobile application ("BARZZ Site"), including all future amendments or modifications thereto (collectively, and together with this document, the API Agreement.

    1. License

    Subject to the terms and conditions of this API Agreement, BARZZ grants you a nonexclusive, non-transferrable, revocable license to a) access and use the BARZZ API to receive BARZZ Content; b) display BARZZ Content on your website, applications, or services ("Your Site"); c) use and display the BARZZ name and logo ("BARZZ Marks") in compliance with the API Display Requirements that BARZZ makes available for use.

    You may not use the BARZZ API, BARZZ Content, or BARZZ Marks for any other purpose without prior written consent from BARZZ. Except for the license granted hereunder, all rights are reserved by BARZZ. You acknowledge and agree that BARZZ may monitor Your Site in order to ensure compliance with the API Agreement.

    2. Access

    In order to access or use the BARZZ API, you must register to receive an API key. All BARZZ API requests must reference your valid API key. You agree to keep your API key confidential and not to share it with any third party.

    If you access or use the BARZZ API on behalf of a business, company, or other entity, you represent that you have authority to bind such entity and its affiliates to the API Agreement and that is fully binding upon each of them. The term "you" will designate such entity and its affiliates. If you do not agree with these terms or do not have authority, you may; not access or use the BARZZ API.

    3. Changes

    BARZZ may update or revise the BARZZ API which may impact the manner in which Your Site accesses or communicates with the BARZZ API. You are responsible for making any changes to Your Site, at your own expense, that may be required as a result of updates or revisions to the BARZZ API. BARZZ will attempt to provide thirty (30) days advanced notice of any changes or revisions to the BARZZ API by posting a notice on the BARZZ website or by email using the email address you provided during registration, unless circumstances require BARZZ to make an immediate change, in which case BARZZ will attempt to provide you with as much advance notice as possible.

    BARZZ reserves the right to update or revise the API Agreement at any time. If BARZZ reasonably determines that a modification may adversely impact you, BARZZ will notify you by email ten (10) days prior to the update or revision taking effect. Your continued access and/or use of the BARZZ API following such notice will constitute your acceptance of the update or revision.

    4. Restrictions

    You agree that you will not, and will not assist or enable others to:

    a. Record, archive, or otherwise store any portion of the BARZZ Content for a period longer than twenty-four (24) hours from the moment the BARZZ Content is received. You must update BARZZ content daily.

    b. Attempt or provide a means for executing bulk download operations.

    c. Alter the BARZZ Content or use it to create or update your own database of business information.

    d. Sell, resell, rent, lease, sublicense, or otherwise charge users solely for the access or use of the BARZZ API or BARZZ Content without explicit written consent from BARZZ.

    e. Use, copy, modify, or distribute the BARZZ API or BARZZ Content for any purpose other than as expressly permitted herein and you may not use the BARZZ API or BARZZ Content in any unlawful manner, for any unlawful purpose, or in any manner inconsistent with the API Agreement.

    f. Access or use the BARZZ API for purposes of monitoring the availability, performance, or functionality of the BARZZ API, BARZZ Content, or BARZZ Site.

    g. Create or disclose metrics about the BARZZ API or BARZZ Content without the explicit written consent from BARZZ.

    h. Display BARZZ Marks or BARZZ Content in a manner that could reasonably imply an endorsement, relationship, or affiliation with or sponsorship between you or a third party and BARZZ, other than your permitted use of the BARZZ API under the terms of the API Agreement.

    i. Display the BARZZ Content on any site that disparages BARZZ or its products or services, or infringes any BARZZ intellectual property or other rights.

    j. Use the BARZZ API in a manner that impacts the stability of BARZZ's servers or impacts the behavior of other applications using the BARZZ API.

    k. Use the BARZZ API, BARZZ Content, or BARZZ Marks in a manner that could reasonably be interpreted to suggest that BARZZ is the author or entity that is responsible, in whole or in part, for the creation or development of any BARZZ Content or that such BARZZ Content represents the views of BARZZ.

    5. Ownership

    As between you and BARZZ, BARZZ owns all right, title and interest in and to the BARZZ API, BARZZ Content, BARZZ Marks, BARZZ Site, and any derivative works or enhancements thereof, including but not limited to all worldwide intellectual property rights therein. You agree not to act in any manner inconsistent with such ownership. Any of BARZZ's rights not expressly granted under this API Agreement are withheld. You agree that you will not challenge BARZZ's ownership of the BARZZ API, BARZZ Content, BARZZ Marks, or BARZZ Site, challenge the validity of the licenses granted under this API Agreement, or otherwise copy or exploit the BARZZ API, BARZZ Content, BARZZ Marks, or BARZZ Site during or after the termination of this API Agreement, except as expressly authorized under this API Agreement.

    6. Term and Termination

    BARZZ reserves the right, in its sole discretion and at any time without notice or liability, to change, suspend or discontinue the BARZZ API and/or suspend or terminate your rights under this API Agreement to access, use, and/or display the BARZZ API, BARZZ Marks, or BARZZ Content. Any termination of the API Agreement will also immediately terminate the licenses granted to you hereunder. Such change, suspension or termination of the BARZZ API may cause your existing services using the BARZZ API to stop functioning properly. Upon termination of this API Agreement, you will immediately: a) cease use of the BARZZ API; and b) delete and remove from all computers, hard drives, networks, and other storage media all copies of the BARZZ API, BARZZ Marks and/or any BARZZ Content, and upon BARZZ's request, certify in writing to BARZZ that such actions have been taken.

    7. Indemnity

    You will indemnify, defend, or at your option settle, any third party lawsuit or proceeding brought against BARZZ, its affiliates or syndication partners, and any of their respective officers, directors, employees and agents, based upon or otherwise arising out of: a) Your use of any BARZZ Content; b) breach of any laws, regulations, or ordinances; and c) Your Site. You will not agree to any settlement that imposes any obligation on BARZZ without BARZZ's prior consent.

    8. Limitation of Liability

    In no event will BARZZ be liable for any special, incidental, exemplary, punitive, or consequential damages (including loss of use, data, business, or profits) arising out of or in connection with this API Agreement, whether such liability arises from any claim based upon contract, warranty, tort (including negligence), strict liability or otherwise, and whether or not it has been advised of the possibility of such loss or damage. The foregoing limitations will survive and apply even if any limited remedy in this API Agreement is found to have failed of its essential purpose.

    9. Miscellaneous

    This API Agreement constitutes the entire agreement between you and BARZZ with respect to the subject matter discussed therein. You may not assign any of the rights or obligations granted hereunder, except with BARZZ's prior written consent. Any attempted assignment in violation of the API Agreement is void. BARZZ may assign the API Agreement, in whole or in part, at any time with or without notice to you. This API Agreement does not create or imply any partnership, agency or joint venture. The failure of BARZZ to exercise or enforce any right or provision of the API Agreement will not constitute a waiver of such right or provision. If any part of this API Agreement is determined to be invalid or unenforceable, that provision will be enforced to the maximum extent permissible and the remaining provisions of this API Agreement will remain in full force and effect.

    10. Support

    The BARZZ API is provided free of charge to you. BARZZ will make reasonable efforts to assist you with technical questions. You are responsible for providing all support and/or technical assistance to your end users regarding the use of Your Site, including any issues related to the BARZZ API or BARZZ Content. BARZZ is not obligated to provide any support and/or technical assistance directly to your users.

    11. Contact

    Please contact BARZZ with any questions regarding this API Agreement.

    Support

    For any questions or issues, please email us at api@barzz.net and include "API" in the subject header.