🏈Getting Started

The Yeerlo API exposes our powerful event capabilities through a GraphQL based API

First Things First

You must sign up for the Yeerlo API here https://build.yeerlo.com, and obtain your API key to be able to continue with our API.

Endpoint Information

The table below shows the endpoint information for interacting with the Yeerlo API:

Role	Value
Base URL	https://api.yeerlo.com

Authorization Header Information

Each interaction with the Yeerlo API must be authenticated. Therefore, you have to provide an authorization header when initiating any call to the Yeerlo API.

headers: {
   Authorization: "Bearer x-your-yeerlo-api-key"
}

API Key Security

To ensure that your API keys are only used by trusted parties, we have implemented measures to restrict their usage to authorized domains and IPs. We recommend that you always adhere to these security practices to prevent unauthorized access to your API keys. You can manage these restrictions directly from the API Key section of your Yeerlo API dashboard. With these restrictions in place, you can safely utilize your keys on both client (i.e with the help of SSR (it's still server side though)) and server sides.

Note: you can only add a maximum of 10 API key restrictions, each with a total length of 100 characters.

Note: If you need to use your API key in your frontend application, please ensure that it is used exclusively on the server side of your setup. In practical terms, this means you should operate a SSR (Server-Side Rendered) application. If not, you should explore setting up a mini server application to handle all sensitive requests and proxy them accordingly.

API Documentation

We've provided comprehensive API documentation, complete with numerous examples, in the Calling Methods section below.

This documentation will guide you through using our GraphQL API, including which methods to call and when to use them, as well as the differences between mutations and queries.

Please note that the fields for each request in the Calling Methods section might not always be up-to-date. For the most accurate information, always check the available fields for the method you're calling in our GraphQL playground here: GraphQL Playground.