Skip to main content

Troubleshooting

Solutions for the most common issues encountered when using the API.

Testing with Postman​

Postman is the recommended tool for exploring and debugging API requests:

  1. Create a new GET request.
  2. Enter the endpoint URL, e.g. http://api.starcitizen-api.com/v2/users/dymerz.
  3. In the Headers tab, add x-api-key with your API key as the value.
  4. Click Send.

This lets you inspect the full request and response, including status codes and headers, without writing any code.

CORS Errors in the Browser​

If you are calling the API directly from browser JavaScript and see a CORS error in the console, this is a browser security restriction — the server must explicitly allow cross-origin requests.

Workarounds:

  • Use Postman or a REST client — not subject to browser CORS policy.
  • Route requests through your own backend — make the API call server-side and forward the response to your frontend.
  • Use a different browser or profile — some browser extensions can relax CORS restrictions for development purposes.
warning

Exposing your API key in client-side JavaScript is a security risk. It is best practice to proxy API calls through your own backend so your key is never sent to the browser.

API Key Not Working​

  • Confirm the key is passed in the x-api-key header, not as a query parameter or in the URL path.
  • Double-check there are no extra spaces or newline characters in the key.
  • Log in via the banner on this site to verify your key is still active.
  • If you recently regenerated your key, make sure you are using the new one.

Data Seems Stale​

If the response data looks outdated:

  • The API serves data from its internal cache by default. Data is kept fresh via fixed refresh intervals per endpoint — see Data Freshness for details. Data is usually fresh without any extra steps.
  • To force an immediate live scrape, add ?refresh=true to your request. This bypasses the cache and fetches directly from the RSI website.
  • ?refresh=true costs 1 daily request from your quota. Use it only when you genuinely need the latest data right now.

See Data Freshness for a full breakdown of how the cache strategy works.

Quota Exceeded​

If you receive "number of calls per day has been exceeded":

  • Stop using ?refresh=true for requests where real-time data is not strictly required. Requests without ?refresh=true never consume quota.
  • Your daily quota resets at a fixed time each day. See Data Freshness for when your next reset occurs.
  • Log in and click Profile to check your remaining quota.
  • If you need a higher quota, reach out via Discord.