The Basics

MakerAPI is designed to be as simple as possible, so you don't need to do lots of processing on the client side. The idea is that you should be able to hit the required endpoint and have all of the information you need without additional work.

How to make requests

All requests should be GET requests, and all requests and responses should use the application/json content type.

Here's an example to get any events for today using Curl.

curl -G --request GET \
  --url 'https://api.makerapi.com/v1/events/today' \
  --header 'Content-type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

And here's an example using Javascript.

const apiBase = 'https://api.makerapi.com/v1';
const response = await fetch(`${apiBase}/events/today`), {
  method: 'GET',
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json",
    "Authorization": 'Bearer YOUR_API_KEY'
  }
});

const result = await response.json();
console.log(result);

How to authenticate

For authentication, you need to provide your API key in an Authorization header. You can get your API key from the account page

curl -G --request GET \
  --url 'https://api.makerapi.com/api/v1/API_ENDPOINT' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Dealing with errors

All API requests return an ok value in the response payload. If this is true the status code will be either 200 or 201. If there is an error, the ok value will be false, and will be returned alongside an error message, with an appropriate error code, usually in the 4xx range.

For example:

{
  "ok": false,
  "error": "Page not found"
}