Sign out Sign out

Your API Key: DEBUGDEBUGDEBUGDEBUG Copied!

Sign using Discord

Status

api version bot version doc version scheduler version pipeline status last update

Description

This is an unofficial Star Citizen fansite, not affiliated with the Cloud Imperium group of companies. All content on this site not authored by its host or users are property of their respective owners. ( robertsspaceindustries.com )

Browse all Star Citizen resources just here .

This API is a simple way to retrieve data from the RSI website like Ships , Users or Organizations or from the Data.p4k file.

Note

This required an API key see the Getting Started to get one.

There are three ways to get data:

  • live : get data directly from RSI website, this method is more slow than de cache but data are up-to-date (each results in live update the cache ).

  • cache : get data from the internal database which is refreshed automatically when a live query is made and every days at 02h00 UTC+00.

  • auto : get data from the cache or from the live depending if the data is in the cache or not (response delay may be variable).

  • eager : get data from the live , if an error occur or you have exceeded the limit, get data from the cache (response delay may be variable).

Warning

Every request in live mode consume your API key , see API Key for more information.

If you just want to get notified on Star Citizen updates, I recommended you to download my app on the Google Play Store Notifier for: Star Citizen .

API Key

The API key is required to restrict abuses and control the charge of the server without slowing the live process.

The API key is a 32 lengths alphanumeric string which is required in every API calls.

Example of API key : 0d32404d021613ba948ba0aeef324ef5 .

Important

Your API key allow you to send 1000 requests per days in live ( cache mode is not restricted) to avoid abuse of live which is very expensive in resources.

How to use the API key

To use the API key simply replace (string:apikey) by your API key .

In this example we will use this API key : 0d32404d021613ba948ba0aeef324ef5

Example for User :

The request:

GET / ( string: apikey ) /v1/ ( string: mode ) /user/ ( string: handle )

Replace using your API key :

GET /0d32404d021613ba948ba0aeef324ef5/v1/ ( string: mode ) /user/ ( string: handle )

And a real call looks like:

GET /0d32404d021613ba948ba0aeef324ef5/v1/cache/user/dymerz

You can obtain all stored data about you using:

GET /0d32404d021613ba948ba0aeef324ef5/v1/me
{
  "message": "ok",
  "source": null,
  "success": 1,
  "data": {
    "creation_date": 1570872555,
    "edition_date": 1572366357,
    "id": 1,
    "oauth_id": "xxxxxxxxxxxxx",
    "privileged": 0,
    "provider": "discord",
    "user_key": "0d32404d021613ba948ba0aeef324ef5",
    "value": 1000
  }
}

Getting Started

Before using the API you should get you own API key to do so, you have to be logged or you can join the Discord .

Using Web login

Simply loggin at the top of this page using one of your favorite account (Discord/Google).

Using Discord

First, join the Discord . Next, go to the channel keys and type the command !apikey , the Bot will send you your API key in a private message.

Note

for more help about commands, type !help

Example:
_images/bot_1.png