Getting started

The Rankedin Public API lets your organization read selected Rankedin data programmatically — for example to check on your own website whether a player holds an active license, or to see which teams in your Team League have paid their fees.

Access is granted per organization through an API key.

Generate your API key

You need to be an admin of a club or organization in Rankedin.

  1. Go to Organization Manager → your organization → Settings.
  2. Scroll to the last section, Public API, and open it.
  3. Click Generate API Key.

 

Once generated, the section shows:

ControlWhat it does
API KeyYour key, hidden by default.
ShowReveals the full key.
CopyCopies the full key to your clipboard.
StatusACTIVE (usable) or revoked (no longer works).
CreatedWhen the key was generated.
Last usedWhen the key was last used in a request, or Never.
Regenerate API KeyCreates a new key. The old one stops working immediately.
Revoke/Disable API KeySwitches the key off immediately. You can generate a new one right away.
Request log activityShows recent request activity for your key.

 

 

Treat the key like a password

Anyone who has it can read your organization's data through the API. Share it only with trusted systems — never in public code, e-mails or screenshots. If you suspect it has leaked, click Regenerate API Key.

There is one active key per organization. Regenerating or revoking takes effect immediately, so every integration using the old key stops working at once. Remember to update your systems.

Call the API from your server, never from the browser

Your website must call the Rankedin API from its backend. If you put the API key into JavaScript running in the visitor's browser, every visitor can read it and use your organization's key.

The correct pattern for a member zone is:

visitor's browser → your own server (holds the API key) → Rankedin API

The API deliberately does not allow browser-to-Rankedin calls from other websites, so a front-end-only integration will not work.

 

Rankedin IDs

Most endpoints identify people and teams by their Rankedin ID, a 10-character code shown on any Rankedin profile.

TypeExampleUsed by
PlayerR000006081Player endpoints
TeamT000105100Team name lookup
Organization803Organization endpoint
Team League14245Team League endpoint

Keep the leading zeros

Always treat a Rankedin ID as text, not a number — the leading zeros are part of the ID and must not be stripped. Organization and Team League IDs, on the other hand, are plain numbers.

What your key can and cannot see

  • License checks and Team League data are limited to your own organization. A player who is not a member of your organization is not returned, and a Team League that is not yours returns 403 Forbidden.
  • Name lookups are public. The organization, player and team name endpoints return the same name shown on the Rankedin website, so they also work for records outside your own organization.
  • The API exposes no personal data beyond what each endpoint documents. The license check in particular returns no name, e-mail, phone or club.

Error responses

Every error returns an HTTP status code and a JSON body in the same shape:

{
  "type":    "https://httpstatuses.com/401",
  "title":   "API key is required.",
  "status":  401,
  "detail":  "The request could not be authenticated.",
  "code":    "api_key_missing",
  "traceId": "0HNNT34M179LL:00000011"
}

Use code in your integration — it is stable. Quote traceId when contacting Rankedin support.

StatusMeaningWhat to do
400The ID or request body is not in the expected formatCheck the format rules for the endpoint
401Key missing, empty, malformed, unknown, or sent more than onceSend exactly one valid X-API-Key header. If the key was revoked, generate a new one
403The Team League does not belong to your organizationUse an ID that belongs to your organization
404Organization, player or team does not existVerify the ID
409More than one record matches the requested Rankedin IDContact Rankedin support
429You hit the rate limitWait and retry, ideally with increasing delays
500Unexpected error on our sideRetry later; contact support with the traceId
503Key validation is temporarily unavailableRetry after a short pause