# Overview

Our API is exposed as an HTTP/1 and HTTP/2 service over SSL. All endpoints live under the URL https://www.juungle.net/api/v1 and then generally follow the REST architecture.

# Current Version

All requests to https://www.juungle.net/api/v1 receive the v1 version of the REST API. In the future, new api versions may supercede v1.

We will consider breaking backwards-compatibility to be a bug once out of beta. Prior to that, we will try to not break backwards-compatibility unless necessary.

# Content Type

All requests must be encoded as JSON with the Content-Type: application/json header. Most responses, including errors, are encoded exclusively as JSON as well.

Content-Type: application/json

# Rate Limiting

We limit the number of calls you can make over a certain period of time. Rate limits vary and are specified by the following header in all responses:

Header Name Description
X-RateLimit-Limit The maximum number of requests you're permitted to make per minute.
X-RateLimit-Remaining The number of requests remaining in the current rate limit window.
X-RateLimit-Reset The time at which the current rate limit window resets in UTC epoch seconds.

If you exceed the rate limit, an error response returns with the status 429 Too Many Requests.

Status: 429 Too Many Requests