Developer Tools

Developer Tools

Note: If you are looking for more information regarding our Dealer and Product Locator tools for brand websites, please visit dealer locator overview or dealer locator support or product locator overview or product locator support. These tools are powered via simple snippets of JavaScript embed code, not via API. You can also contact our brand team for more information on how to easily implement Locally on a client's website.

API Access

At this time we're releasing access to system data on a case-by-case basis for specific projects with current clients. If you would like to request an API key, please get in touch with us to discuss your specific needs.

API Overview

All requests must be made via the https protocol on port 443. The API is RESTful so we accept the following request types: GET, PUT, POST, and DELETE.

The key parameter must be included in the query string of your request and the value of this parameter is the key we've supplied you with once your account has been approved for API access.

All requests must be made to the following base URL:

https://www.locally.com/api/v1/{endpoint}

Rate Limit

We have a rate limit of 250 requests per minute. If you intend to use our API for a production web site, please consider caching the data on your end. We will temporarily disable accounts who exceed the rate limit.

Client Libraries

A Locally.com API client for .NET by Chad Kittel of Trek

Available Endpoints

taxonomy

Returns the full Locally.com taxonomy category list with IDs and information on category nesting

brands

Returns list of vendor companies along with their Locally.com IDs

  • Optional Parameter: is_participating (boolean) returns only participating brands who are directly controlling their catalog data

catalog

Returns full product data (at the UPC level) for a given company.

  • Required Parameter brand_id (integer)

dealers

Returns full, active dealer data for a given brand company.

  • Required Parameter brand_id (integer)

company

Returns a single company record using their web domain as a filter. For retailer companies this will also return a nested list of their retail locations (if the with_stores parameter is specified).

  • Required Parameter: domain (string)
  • Optional Parameter: with_stores (string)

product

Returns specific product data.

  • Required Parameter product_id (integer)

products

Returns in-stock product lists for a specific retailer location. Also includes product image urls, direct links to retailer subdomains and category information. Data is sorted by popularity.

  • Required Parameter store_id (integer)
  • Optional Parameter category_id (integer)
  • Optional Parameter brand_id (integer)

stores

Returns a location list for a specific brand or retailer company_id. Data is sorted by proximity to optional specified coordinates. Otherwise data is sorted alphabetically by name.

  • Required Parameter company_id (integer)
  • Optional Parameter lat (latitude, float)
  • Optional Parameter lng (longitude, float)

upc

Returns specific upc data.

  • Required Parameter code (string)