Sign out Sign out

Your API Key: DEBUGDEBUGDEBUGDEBUG Copied!

Sign using Discord

Note

This require an API Key see the Getting Started to get one.

2. From Gamedata

Perform a search on the Data.p4k file

2.1. Get Items

GET / ( string: apikey ) /v1/gamedata/get/ ( string: version ) / ( string: category )

Get items data

Example request :

GET /xxxxxxxx/v1/gamedata/get/3.6.1/ship?name=Avenger HTTP/1.1
Host: api.starcitizen-api.com
Accept: application/json

Example response :

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "message": "ok",
  "success": 1,
      "source": "gamedata",
  "data": [
    {
      "crossSectionMultiplier":"0.52,0.37,0.51",
      "displayname":"AEGS Avenger Dead",
      "id":"modVehicle",
      "itemPortTags":"AEGS_Avenger_Base",
      "landingOffset":"0,0,-4.42",
      "name":"AEGS_Avenger",
      "requiredItemTags":"",
      "size":2,
      "subType":"Vehicle_Spaceship",
      "HudPaletteScheme":"AEGS",
      "Cameras":{

      },
      "DamageTech":{

      },
      "Damages":{

      },
      "Helpers":{

      },
      "MovementParams":{

      },
      "Particles":{

      },
      "Parts":{

      },
      "Physics":{

      },
      "Pipes":{

      },
      "Shield":{

      },
      "VisorElement":{

      }
    }
  ]
}
Query Parameters
  • apikey – your API key can be obtained on the Discord.

  • category – the category to get.

Parameters
  • name ( str ) – the name of the item to search.

Status Codes

2.2. List of Versions

GET / ( string: apikey ) /v1/gamedata/list/versions

List all supported versions.

Example request :

GET /xxxxxxxx/v1/gamedata/list/versions HTTP/1.1
Host: api.starcitizen-api.com
Accept: application/json

Example response :

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "message": "ok",
  "success": 1,
      "source": "gamedata",
  "data": [
    "3.6.1",
    "3.6.0",
    "3.7.1",
  ]
}
Query Parameters
  • apikey – your API key can be obtained on the Discord.

Status Codes

2.3. List of Categories

GET / ( string: apikey ) /v1/gamedata/list/categories

List all supported categories.

Example request :

GET /xxxxxxxx/v1/gamedata/list/categories HTTP/1.1
Host: api.starcitizen-api.com
Accept: application/json

Example response :

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "message": "ok",
  "success": 1,
      "source": "gamedata",
  "data": [
    "none",
    "ship",
    "weapon",
    "weapon_magazine",
    "commodity",
    "tag",
    "shop",
    "manufacturer",
    "starmap",
    "every"
  ]
}
Query Parameters
  • apikey – your API key can be obtained on the Discord.

Status Codes

2.4. Search in Data

GET / ( string: apikey ) /v1/gamedata/search/ ( string: version ) / ( string: category )

Search a combination of key - value in the Gamedata.

Use the combination of <KEY>=<DATA> in GET parameters to perform a search in the JSON, see the example below for more details.

Example request :

GET /xxxxxxxx/v1/gamedata/search/3.6.1/weapon?__ref=699db405-4ca1-4993-ba58-a9f90001ae6b HTTP/1.1
Host: api.starcitizen-api.com
Accept: application/json

Example response :

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "message": "ok",
  "success": 1,
      "source": "gamedata",
  "data": {
    "BBoxSelection":0,
    "Category":"Default",
    "Components":{

    },
    "Icon":"",
    "Invisible":0,
    "StaticEntityClassData":null,
    "__path":"libs/foundry/records/entities/scitem/weapons/fps_weapons/apar_special_ballistic_01.xml",
    "__ref":"699db405-4ca1-4993-ba58-a9f90001ae6b",
    "__type":"EntityClassDefinition",
    "lifetimePolicy":"00000000-0000-0000-0000-000000000000",
    "tags":{

    }
  }
}
Query Parameters
  • apikey – your API key can be obtained on the Discord.

  • category – the category to get.

Status Codes