Getting started

Create an account

To access our API, you'll need an account. It's free and you can get it here.

Make sure you use an email which you have access to. We will send the API key and secret to that email.

Authentication headers

You'll need to add the API key and secret sent to you via email in the headers of every request to our API.

curl -X POST \
https://api.rtrn.io/v1/links/create \
-H 'Content-Type: application/json' \
-H 'x-rtrn-key: <YOUR API KEY HERE>' \
-H 'x-rtrn-secret: <YOUR API SECRET HERE>'

Rate limits

Rate limits apply even when making authenticated calls. This is to prevent abuse and spam in the service. Rate limits for authenticated accounts are higher, but if reached, a 5 minute ban will be applied to the IP. An error 429 "Too many requests" will be returned.

{
"name": "TooManyRequestsError",
"message": "API requests limit reached. Try again in a few minutes.",
"code": 429
}

Error responses

Error responses are always composed of these 3 fields:

  • name: name of the error

  • message: details/reason about the error

  • error: http status code of the error

Here are some examples of error responses:

{
"name": "InvalidContentError",
"message": "Not a valid URL",
"code": 400
}
{
"name": "ResourceNotFoundError",
"message": "Link <5U6k_GDbV> not found",
"code": 404
}