Introduction

Most endpoints require authentication using an API key in the Authorization header. You can get your own key from our website in the settings page. Read more about this header here.

You can generate up to 5 keys on our website

Each key is limited to 5,000 requests per month by default, but you can increase your limit by contacting us on our discord server

In case you can not see the support channel please enable Show all channels

Some endpoints are protected by Cloudflare Under Attack Mode, which displays a CAPTCHA page before completing the request. To bypass this, include an authorization header with your API key — note that doing so will count toward your request quota. — read more here

Every endpoint is cached to some point, so you can expect consistent results. All responses follow the same structure:

  • success is a boolean indicating whether the request was successful

  • data varies by endpoint (you can find the specific data type on each endpoint’s page)

  • query_time is the time taken to process the request, in seconds

You can view examples on our github page at Alyx-Network/API

Last updated