Data API
Pull your members, their activity and their balances into your CRM, your warehouse or your BI tool.
Read-only HTTP access to your own community's members, activity, balances and item holdings, authenticated with a key. It never touches the fan experience.
Scope and first uses
The three things partners built with it first:
- A CRM segment. Members and their balances joined onto the email list, so a campaign can go to fans above level ten rather than to everybody.
- A warehouse table. A nightly pull of members and activity into the same place the store data already lands, so app engagement and revenue can be looked at in one query.
- A dashboard your leadership already reads. Headline totals into the BI tool that shows every other number, rather than one more login for one more panel.
Getting a key
Ask your FanBase contact for a key.
It is shown once, at creation and never again. Put it straight into a password manager or your secret store. If it is lost, the fix is a new key.
A key can carry an expiry. Ask for one on anything short-lived, like a contractor's integration or a one-off migration. A key with no expiry is a key that outlives the person who asked for it.
Tell us when a key should stop working and we revoke it.
This is a server to server API. The key must never go into a browser, a mobile app, a front end build or anything else a fan can read. The key reads your whole community, and a fan who finds it can read it too. Put it on a server, in a scheduled job, or in your warehouse's connector.
If what you are building is fan facing, use the SDK instead. It authenticates as the fan and returns only that fan's data. See the FanBase SDK API reference.
Calling it
Send the key in an x-api-key header. The base URL is https://api.gamerbase.gg.
curl -H "x-api-key: $FANBASE_API_KEY" \
"https://api.gamerbase.gg/v1/data/members?limit=100&offset=0"No OAuth dance and no token refresh.
Resources you can read
| Resource | What it is for |
|---|---|
| Members | One row per fan in your community. The join key for everything else here, and the table your CRM segments against. |
| Member deletions | Fans who deleted their account. The only way to honour a deletion in your own systems too, because a deleted fan stops appearing in members, and in the member export, with nothing to mark the absence. |
| Activity | What fans did and when. The event log underneath every number on the dashboard, and the source for retention and cohort work. |
| Resource balances | One balance per fan per resource, so XP and every spendable currency your community has created. What you segment on when you want your top thousand rather than all of them. |
| Item holdings | Which collectibles and inventory items each fan owns. Useful for checking who actually holds the thing a campaign was built around. |
| Loot box openings | Every opening and what came out of it. Reconciliation, and answering the fan who says the odds are wrong. |
| Analytics totals | Headline counts for the whole community, totalMembers and totalQuestsCompleted among them. The full set is in the reference. The cheap call for a status board that does not need per fan rows. |
| Quest catalogue | Your published quests. Public, and the only part of this that needs no key at all. |
Paging and syncing
Every list response has the same shape: data holds the rows, total holds how many rows match in full, and offset says where the page you are holding starts. You page with limit and offset. The current maximum for limit is in the reference, which is generated from the API and is the value to code against.
Use updatedSince. Pass a timestamp and you get back only rows that changed after it. Your first run pulls the whole community. Every run after that pulls the handful of rows that moved since the last one.
Two things to get right when you build that loop.
Store the time the run started. Rows can be written while you are paging, so a cursor set to the last row you saw skips them. Anchor on the run start, overlap the next run by a few minutes, and a row written mid-sync still gets picked up. Write your rows so that seeing the same one twice is harmless, and the overlap costs you nothing.
Read member deletions on the same schedule as members. A deleted fan stops appearing in members, and an incremental sync built on updatedSince alone has no way to notice an absence. It keeps the stale row in your CRM permanently, and keeps emailing someone who asked to be forgotten. Deletions is a separate resource precisely so you can pull it and act on it.
Rate limits
The limit is per minute, per key, and it is set high enough that a well built incremental sync will never come close. Every response carries X-RateLimit-* headers with the live numbers, and those headers are the authority. A client that reads them and backs off when the remaining count gets low stays inside the limit without any tuning from you.
If you are hitting the limit, the cause is almost always a full re-download on a schedule.
The interactive reference
Every endpoint, every parameter and every response shape is at api.gamerbase.gg/api, and you can call them from the page with your key. It is generated from the API, so it is the current shape rather than a copy of one. Point your engineers, and your coding agent, at it first.
Webhooks
ExploringToday you poll. Webhooks would invert that: you would register a URL, and the platform would post to you when something happened, so a quest completion could reach your CRM in seconds rather than at the next sync.
It is under discussion rather than scheduled. If a real time reaction is what your campaign depends on, tell your FanBase contact: knowing a partner needs it is what gets it a date.