This page will help you get started with developing with the LocalScale API.

Welcome to LocalScale.

LocalScale is a public benefit organization focusing on the development of resilient and sustainable local economies through the use of technology, science and regenerative activities.

Using the LocalScale API

The LocalScale API provides access to LocalScale's data layer and a programmatic access to the platform's ecosystem.

29762976

This API is always under development. If you need help with implementing the API for your system, please contact us and we'll help you with your project.

If you notice the docs are out of date or are unclear, please don't be shy about clicking the "Suggest Edits" link! We're working to keep these docs up to date, however sometimes we get behind – and we'd love your help.

Prerequisites

Access to the LocalScale API is granted to organizations being part of the LocalScale Preferred Partners group.

Authentication

Authentication requires an API key, Please contact us to get an API key. You will need to include your key in every request made to the API. The API key has have to be provided as an HTTP request header called X-LOCALSCALE-APIKEY.

Sandbox vs Production

API development will always have to start on our sandbox. Once you feel that you got things under control, just send us a note and we'll enable your access to production.

Rate Limit

The LocalScale API allows 1,000 calls within a 1 hour window per calling client (per api key).

HTTP Headers and Response Codes

Use the HTTP headers in order to understand where the application is at for a given rate limit, on the method that was just utilized. The HTTP headers to monitor are the following:

x-ratelimit-limit: the rate limit ceiling for that given endpoint
x-ratelimit-remaining: the number of requests left for the 15 minute window

When hitting the rate limit, please pause your code for 1 hour and retry the call.

Blacklisting

If a client application abuses the rate limits, it will be blacklisted. Blacklisted client apps are unable to get a response from the LocalScale API. If you or your application has been blacklisted and you think there has been a mistake, you can email us at [email protected] to request assistance.

Support and Feedback

Please feel free to report issues either through our Intercom channel or by sending emails to [email protected]