How it works

In order to paginate requests API consumers will need to check the pagination field inside each response.

Check the following response example:

{
    passports: [...],
    pagination: {
        total: 100,
        current_page: 1,
        last_page: 10
    }
}

In order to fetch the next page a new request will need to be performed with the page query param being passed as the current_page + 1.

https://api.talentprotocol.com/api/v1/passports?id=<id>&page=<current_page + 1>

You will reach the last page when the current_page is equal to the last_page.

{
    passports: [...],
    pagination: {
        total: 1000,
        current_page: 10,
        last_page: 10,
    }
}

You can learn more about this in the next chapter.

X-API-KEY

The API key is the entry point for the Talent Protocol API. In order to perform requests it needs to be passed on every request.

We use the header X-API-KEY to retrieve the access key and validate your access to our API.

There're two types of API keys:

• read_only: Can only access GET requests

• write: Can access all requests

How to request an API key

You can request one API key by opening a ticket on Discord.

API Key Rate Limits

• For free users, API usage is subject to 5,000 requests/month.

• Check more details about pricing .

IP Rate Limits

• Each IP address has a maximum of 25 requests in 10 seconds.

Fair Use Policy

The following activities are prohibited:

• Excessive Use: Overuse of the API beyond the designated limits that impacts system performance or fairness for other users.

• Automated Abuse: Using scripts, bots, or automated tools to excessively query the API, harvest data, or engage in any behavior that could overload our systems.

• Redistribution: Reselling, sublicensing, or sharing your API Key with unauthorized third parties is strictly prohibited.

• Data Misuse: Manipulating, distorting, or misrepresenting the data obtained from our API, or using the data for illegal purposes.

Inactivity Clause

• We reserve the right to deactivate or cancel an API Key if it has been inactive for more than 30 consecutive days. Inactivity is defined as no API requests made during this period. If your API Key is deactivated due to inactivity, you may need to request a new key or contact support for reinstatement.