Getting Started

This page will help you get started with the Habit Dash API.

Authentication

API authentication is achieved by placing an "X-API-KEY" key in your header, with the value being your API key generated on the Habit Dash data page.

For example, to pull the available list of fields with Python the code would look like this:

Python

import requests

url = "https://api.habitdash.com/v1/fields/"

headers = {
    "accept": "application/json",
    "x-api-key": "PUT_API_KEY_HERE"
}

response = requests.request("GET", url, headers=headers)

print(response.text)

Rate Limit

API requests are throttled at 2 requests / second. Each request will return up to 5000 items and be paginated when the amount of data exceeds that.

🚧

If you have a large quantity of data to download please build delays into your requests or you may see 429 errors (too many requests).