Sign out Sign out

Your API Key: DEBUGDEBUGDEBUGDEBUG Copied!

Profile Sign using Discord

Profile ×

• Hits remaining: NaN

• Last call at :NaN

• Created at :NaN

• Renew API key Unregister

• This can't be undone, do you want to continue ?

  Yes No

Note

This requires an API Key . See the Getting Started page fetch one.

1. From Website

Perform a search on the RSI website

1.1. User

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

Get information about a user

Example request :

GET /xxxxxxxx/v1/live/user/dymerz 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": "live",
  "data": {
    "organization": {
      "image": "https://robertsspaceindustries.com/media/1fvt89w8g12brr/heap_infobox/PROTECTORA-Logo.png",
      "name": "Protectorat (EU/QC/974/PC)",
      "rank": "Membre",
      "sid": "PROTECTORA"
    },
    "profile": {
      "badge": "No Scents",
      "badge_image": "https://robertsspaceindustries.comhttps://media.robertsspaceindustries.com/uj5p2496zbps5/heap_thumb.png",
      "display": "[\u2126P] Dymerz",
      "enlisted": "2016-08-19T00:00:00.000000",
      "fluency": [
        "French",
        "English"
      ],
      "handle": "Dymerz",
      "id": "#1461338",
      "image": "https://robertsspaceindustries.com/media/0ffw9qn1fqi8qr/heap_infobox/Vaultboy.png",
      "page": {
        "title": "[\u2126P] Dymerz | Dymerz - Protectorat (EU/QC/974/PC) | PROTECTORA (Membre) - Roberts Space Industries | Follow the development of Star Citizen and Squadron 42",
        "url": "https://robertsspaceindustries.com/citizens/dymerz"
      }
    }
  }
}

Query Parameters

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

• mode – live , cache , auto or eager .

• handle – the handle of the user.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.2. Organization

GET / ( string: apikey ) /v1/ ( string: mode ) /organization/ ( string: sid )

Get information about an organization using a sid

Example request :

GET /xxxxxxxx/v1/live/organization/PROTECTORA 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": "live",
  "data": {
    "archetype": "Corporation",
    "banner": "https://robertsspaceindustries.com/media/5bxw85k2so4lbr/banner/PROTECTORA-Banner.png",
    "commitment": "Hardcore",
    "focus": {
      "primary": {
        "image": "https://robertsspaceindustries.com/media/7nk9059i8lnfmr/icon/Security.png",
        "name": "Security"
      },
      "secondary": {
        "image": "https://robertsspaceindustries.com/media/xhuvehkwn6qsnr/icon/Freelancing.png",
        "name": "Freelancing"
      }
    },
    "headline":{
      "html": "<div class=\"body markitup-text\">\n\t  \t<h2>Ami francophone, fais un tour sur <a href=\"https://tv.protectorat.eu\" rel=\"nofollow\">https://tv.protectorat.eu</a></h2>\n\n<h4>Candidat : lis attentivement notre charte et notre manifeste. Tout est expliqu&#233; pour bien postuler. Puis viens sur notre discord <a href=\"https://discord.gg/fSVn52B\" rel=\"nofollow\">https://discord.gg/fSVn52B</a></h4>\n\t  \t</div>\n\t  \t\n",
      "plaintext": "\n\t  \tAmi francophone, fais un tour sur https://tv.protectorat.eu\n\nCandidat : lis attentivement notre charte et notre manifeste. Tout est expliqué pour bien postuler. Puis viens sur notre discord https://discord.gg/fSVn52B\n\t  \t"
    },
    "href": "https://robertsspaceindustries.com/orgs/PROTECTORA",
    "lang": "French",
    "logo": "https://robertsspaceindustries.com/media/1fvt89w8g12brr/logo/PROTECTORA-Logo.png",
    "members": 1263,
    "name": "Protectorat (EU/QC/974/PC)",
    "recruiting": true,
    "roleplay": false,
    "sid": "PROTECTORA",
    "url": "https://robertsspaceindustries.com/orgs/PROTECTORA"
  }
}

Query Parameters

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

• mode – live , cache , auto or eager .

• sid – the sid (Spectrum Identifier) of the organization.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.3. Organization Members

GET / ( string: apikey ) /v1/ ( string: mode ) /organization_members/ ( string: sid )

Get members of an organization using a sid .

Example request :

GET /xxxxxxxx/v1/live/organization_members/PROTECTORA 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": "live",
  "data": [
    {
      "display": "[ΩP] Dymerz",
      "handle": "Dymerz",
      "image": "https://robertsspaceindustries.com/media/0ffw9qn1fqi8qr/heap_infobox/Vaultboy.png",
      "rank": "Membre",
      "stars": 3
      "roles": [
        "Military"
      ],
    },
  ],
}

Parameters

• page ( int ) – the page to get, 32 members per page (default: 1).

• rank ( int ) – the id of the rank to search.

• role ( int ) – the id of the role to search.

• main_org ( bool ) – true or false

Query Parameters

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

• mode – live .

• sid – the sid (Spectrum Identifier) of the organization.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.4. Versions

GET / ( string: apikey ) /v1/ ( string: mode ) /versions

Get a list of all versions.

Example request :

GET /xxxxxxxx/v1/live/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": "live",
  "data": [
    "3.4.3",
    "3.4.2",
    "3.4.1",
    "3.4.0",
    "3.3.7",
    "3.3.6",
    "3.3.5",
    "3.3.0",
    "3.2.2",
    "3.2.1",
    "3.2.0",
    "3.1.4",
    "3.1.3",
    "3.1.2",
    "3.1.1",
    "3.1.0",
    "3.0.1",
    "3.0.0",
    "2.6.3",
    "2.6.2"
  ]
}

Query Parameters

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

• mode – live , cache , auto or eager .

• filter – latest return only the latest version.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.5. Ships

GET / ( string: apikey ) /v1/ ( mode ) /ships

Get information about ships

This request may take a lot of time, according to the page_max parameter.

Prefer to use this method in cache mode for better performance.

Example request :

GET /xxxxxxxx/v1/live/ships?classification=multi&classification=combat&page_max=1&price_max=50 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": "live",
  "data": [
    {
      "afterburner_speed": "1160",
      "beam": "18.0",
      "cargocapacity": "6",
      "chassis_id": "16",
      "compiled": {

      },
      "description": "Inspired by Consolidated Outland CEO Silas Koerner\u2019s cutting edge vision, the Mustang Alpha is a sleek, stylish spacecraft that uses ultralight alloys to push power ratios to the limits, albeit sometimes unsafely. And now, with the optional Cargo Carrier, you can have the Alpha\u2019s advantages without sacrificing carrying capacity.",
      "focus": "Cargo",
      "height": "9.0",
      "id": "65",
      "length": "21.5",
      "manufacturer": {

      },
      "manufacturer_id": "22",
      "mass": "32970",
      "max_crew": "1",
      "media": [

      ],
      "min_crew": "1",
      "name": "Mustang Alpha",
      "pitch_max": "90.0",
      "price": 36.3,
      "production_note": null,
      "production_status": "flight-ready",
      "roll_max": "135.0",
      "scm_speed": "255",
      "size": "small",
      "time_modified": "2 years ago",
      "time_modified.unfiltered": "2017-10-24 19:42:35",
      "type": "multi",
      "url": "/pledge/ships/mustang/Mustang-Alpha",
      "xaxis_acceleration": "73.8",
      "yaw_max": "90.0",
      "yaxis_acceleration": "84.1",
      "zaxis_acceleration": "72.2"
    }
  ]
}

Query Parameters

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

• mode – live , cache , auto or eager .

Parameters

• name ( str ) – the name of the ship to search.

• classification ( str ) – the type of ship to get, you can pass this parameter at multiple times. ( combat , transport , exploration , industrial , support , competition , ground , multi ).

• length_min ( int ) – the minimal length (in meters).

• length_max ( int ) – the maximal length (in meters).

• crew_min ( int ) – the minimal crew count.

• crew_max ( int ) – the maximal crew count.

• price_min ( int ) – the minimal price (in dollars).

• price_max ( int ) – the maximal price (in dollars).

• mass_min ( int ) – the minimal mass (Kg).

• mass_max ( int ) – the maximal mass (Kg).

• page_max ( int ) – the numbers of pages to process (1 page contains 10 ships), one page takes around 15s to process.

• id ( int ) – the ship id (in cache mode only).

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

Note

Request in cache mode with no parameters will return all stored ships.

1.6. Roadmap

GET / ( string: apikey ) /v1/ ( string: mode ) /roadmap/ ( string: board )

Get information about Roadmap

Example request :

GET /xxxxxxxx/v1/live/roadmap/starcitizen 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": "live",
  "data": [
    {
    "board_id": 1,
    "cards": [
      {
        "board_id": 1,
        "body": "These improvements will include updates to the model geometry, make sure characters are well lit inside the helmets, and fix bugs such as incidents where the lights persist even when helmets are not on.",
        "category_id": 3,
        "completed": 1,
        "description": "Improving overall look of helmets and visual fidelity of lighting",
        "id": "355",
        "importer_id": "SC-236658",
        "inprogress": 8,
        "name": "Helmet Polish & Lighting Improvements",
        "order": 0,
        "release_id": 9,
        "released": 1,
        "scheduled_at": null,
        "tasks": 1,
        "thumbnail": {
          "id": "1296482",
          "urls": {
          "large": "/media/1w9r0ekh3lj0er/hub_large/HelmetPolish.jpg",
          "rect": "/media/1w9r0ekh3lj0er/product_thumb_large/HelmetPolish.jpg",
          "source": "/media/1w9r0ekh3lj0er/source/HelmetPolish.jpg",
          "square": "/media/1w9r0ekh3lj0er/heap_infobox/HelmetPolish.jpg"
          }
        },
        "time_created": 1532669929,
        "time_modified": 1545422747,
        "url_slug": "Helmet-Polish-Lighting-Improvements"
      }
    ],
    "description": "Released March 31, 2018",
    "id": "9",
    "importer_id": "3.1.0",
    "name": "3.1.0",
    "order": 1,
    "released": 1,
    "scheduled_at": null,
    "time_created": 1532669581,
    "time_modified": 1549668479,
    "url_slug": "310"
    }
  ]
}

Query Parameters

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

• mode – live , cache , auto or eager .

• board – starcitizen or squadron42 .

Parameters

• version ( str ) – the version to search.

• date_min ( int ) – the minimal date (in timestamp) to search in the history (in cache mode only).

• date_max ( int ) – the maximal date (in timestamp) to search in the history (in cache mode only).

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.7. Progress Tracker Teams

GET / ( string: apikey ) /v1/ ( string: mode ) /progress-tracker

Get Progress-Tracker Deliverables

Example request :

GET /xxxxxxxx/v1/live/progress-tracker 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": "live",
  "data": [
    {
      "__typename": "Team",
      "description": "",
      "endDate": "Thu, 25 Nov 2021 00:00:00 +0000",
      "numberOfDeliverables": 16,
      "slug": "g42qg07ipfday",
      "startDate": "Mon, 04 Jan 2021 00:00:00 +0000",
      "title": "Actor Feature Team",
      "uuid": "4d868571-b2cd-5f0a-b52e-822c25c62426"
    }
  ]
}

Query Parameters

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

• mode – live , cache , auto or eager .

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.8. Progress Tracker Info

GET / ( string: apikey ) /v1/ ( string: mode ) /progress-tracker/ ( string: team_slug )

Get Progress-Tracker Info

Example request :

GET /xxxxxxxx/v1/live/progress-tracker/g42qg07ipfday 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": "live",
  "data": [
    {
      "__typename": "Deliverable",
      "description": "Improved signature system, supporting much greater distances, and dampening of signatures by environmental interference and larger signatures. Improved Scanning, driven by the same signature system as the Radar and Ping, available in Ships, ground vehicles, and FPS",
      "disciplines": {
        "__typename": "Discipline",
        "color": "#58A949",
        "numberOfMembers": 1,
        "timeAllocations": [
          {
            "__typename": "TimeAllocation",
            "endDate": "Thu, 21 Jan 2021 00:00:00 +0000",
            "partialTime": false,
            "startDate": "Mon, 04 Jan 2021 00:00:00 +0000",
            "uuid": "67101691-5197-5cf1-8cef-281cdae1f482"
          }
        ],
        "title": "Engineering",
        "uuid": "f646813d-0707-5ddd-b68f-5aa995b6ce4f"
      },
      "endDate": "Thu, 01 Apr 2021 00:00:00 +0000",
      "numberOfDisciplines": 2,
      "projects": [
        {
          "__typename": "Project",
          "logo": "/media/b9ka4ohfxyb1kr/source/StarCitizen_Square_LargeTrademark_White_Transparent.png",
          "title": "SC"
        }
      ],
      "slug": "47hp2kkju0ane",
      "startDate": "Mon, 04 Jan 2021 00:00:00 +0000",
      "title": "FPS Radar / Scanning",
      "uuid": "a68c9365-7670-5742-b72c-4c4a5e318947"
    }
  ]
}

Query Parameters

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

• mode – live , cache , auto or eager .

• team_slug – the slug field of the team.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.9. Stats

GET / ( string: apikey ) /v1/ ( string: mode ) /stats

Get general information like the numbers of citizens

Example request :

GET /xxxxxxxx/v1/live/stats 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": "live",
  "data": {
    "current_live": "3.4.3",
    "fans": 2266424,
    "fleet": 1680544,
    "funds": 22218302975
  }
}

Query Parameters

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

• mode – live , cache , auto or eager .

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.10. Telemetry

GET / ( string: apikey ) /v1/ ( string: mode ) /telemetry/ ( string: version )

Get some telemetry info

The version parameter in this format x.x (e.g: 3.7 ).

Example request :

GET /xxxxxxxx/v1/live/telemetry/3.7?timetable=DAY HTTP/1.1
Host: api.starcitizen-api.com
Accept: application/json

Example response :

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

{
  "data": {
    "current": {
      "last_updated_at": 1573257861,
      "latency_avg": {
        "value": 68.38865320417109
      },
      "load_times_hdd": {
        "avg": 129.66589007075308,
        "max": 500004.96875,
        "min": 0.01583999954164028,
        "percent": 13.475276602695521,
        "percentiles": {
          "1_0": 15.85850604754775,
          "25_0": 40.60227440987722,
          "50_0": 115.46354172149242,
          "5_0": 20.923920453548348,
          "75_0": 183.54955903652294,
          "95_0": 306.42416247966605,
          "99_0": 423.85930390812376
        }
      },
      "load_times_ssd": {
        "avg": 36.23522484252711,
        "max": 131835.1875,
        "min": 0.01140000019222498,
        "percent": 86.52472339730448,
        "percentiles": {
          "1_0": 13.872536919385118,
          "25_0": 22.2314264228269,
          "50_0": 27.436043727704394,
          "5_0": 16.87339623369419,
          "75_0": 40.68148631012266,
          "95_0": 73.37471391678743,
          "99_0": 173.63653717886677
        }
      },
      "popular_resolutions": [

      ],
      "stability_score": 0.10139866532744546
    },
    "past": {

    }
  },
  "message": "ok",
  "source": "live",
  "success": 1
}

Query Parameters

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

• mode – live , cache , auto or eager .

• version – the versions, starting from 3.2

Parameters

• timetable ( str ) – The time range ( DAY , WEEK , MONTH ), DAY is only usefull for the latest version.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.11. Starmap Systems

GET / ( string: apikey ) /v1/ ( string: mode ) /starmap/systems

Get information about Systems

Example request :

GET /xxxxxxxx/v1/live/starmap/systems?name=Stanton 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": "live",
  "data": {
    "affiliation": [
      {
        "code": "uee",
        "color": "#48bbd4",
        "id": "1",
        "membership.id": "741",
        "name": "UEE"
      }
    ],
    "aggregated_danger": 10,
    "aggregated_economy": 10,
    "aggregated_population": 10,
    "aggregated_size": "4.85000000",
    "code": "STANTON",
    "description": "While the UEE still controls the rights to the system overall, the four planets themselves were sold by the government to four megacorporations making them the only privately-owned worlds in the Empire. Though subject to the UEE\u2019s Common Laws and standard penal code, the UEE does not police the region. Instead, private planetary security teams enforce the local law.",
    "id": "314",
    "info_url": null,
    "name": "Stanton",
    "position_x": "49.53471800",
    "position_y": "-2.63396450",
    "position_z": "16.47529200",
    "status": "P",
    "thumbnail": {
    "images": {
      "post": "https://robertsspaceindustries.com/media/anxi4tr0ija81r/post/JStanton-Arccorp.jpg",
      "product_thumb_large": "https://robertsspaceindustries.com/media/anxi4tr0ija81r/product_thumb_large/JStanton-Arccorp.jpg",
      "subscribers_vault_thumbnail": "https://robertsspaceindustries.com/media/anxi4tr0ija81r/subscribers_vault_thumbnail/JStanton-Arccorp.jpg"
    },
    "slug": "anxi4tr0ija81",
    "source": "https://robertsspaceindustries.com/media/anxi4tr0ija81r/source/JStanton-Arccorp.jpg"
    },
    "time_modified": "2018-01-27 01:36:42",
    "type": "SINGLE_STAR"
  }
}

Query Parameters

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

• mode – live , cache , auto or eager .

Parameters

• name ( str ) – the name of the system to search.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.12. Starmap Tunnels

GET / ( string: apikey ) /v1/ ( string: mode ) /starmap/tunnels

Get information about Tunnels

Example request :

GET /xxxxxxxx/v1/live/starmap/tunnels?id=1188 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": "live",
  "data": {
    "direction": "B",
    "entry": {
      "code": "STANTON.JUMPPOINTS.PYRO",
      "designation": "Stanton - Pyro",
      "distance": "1.80000000",
      "id": "1689",
      "latitude": "-5.00000000",
      "longitude": "130.00000000",
      "name": null,
      "star_system_id": "314",
      "status": "P",
      "type": "JUMPPOINT"
    },
      "entry_id": "1689",
      "exit": {
      "code": "PYRO.JUMPPOINTS.STANTON",
      "designation": "Pyro - Stanton",
      "distance": "9.00000000",
      "id": "1740",
      "latitude": "-1.00000000",
      "longitude": "-5.00000000",
      "name": null,
      "star_system_id": "318",
      "status": "P",
      "type": "JUMPPOINT"
    },
    "exit_id": "1740",
    "id": "1188",
    "name": null,
    "size": "M"
  },
}

Query Parameters

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

• mode – live , cache , auto or eager .

Parameters

• id ( str ) – the id of the tunnel to search.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.13. Starmap Species

GET / ( string: apikey ) /v1/ ( string: mode ) /starmap/species

Get information about Species

Example request :

GET /xxxxxxxx/v1/live/starmap/species 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": "live",
  "data": [
    {
      "code": "HUMAN",
      "id": "1",
      "name": "Human"
    },
    {
      "code": "BANU",
      "id": "2",
      "name": "Banu"
    },
    {
      "code": "XIAN",
      "id": "3",
      "name": "Xi'An"
    },
    {
      "code": "TEVARIN",
      "id": "4",
      "name": "Tevarin"
    },
    {
      "code": "KRTHAK",
      "id": "5",
      "name": "Kr'Thak"
    },
    {
      "code": "VNCL",
      "id": "6",
      "name": "Vanduul"
    }
  ]
}

Query Parameters

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

• mode – live , cache , auto or eager .

Parameters

• name ( str ) – the name of the species to search.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.14. Starmap Affiliations

GET / ( string: apikey ) /v1/ ( string: mode ) /starmap/affiliations

Get information about Affiliations

Example request :

GET /xxxxxxxx/v1/live/starmap/affiliations 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": "live",
  "data": [
     {
      "code": "uee",
      "color": "#48bbd4",
      "id": "1",
      "name": "UEE"
    },
    {
      "code": "BANU",
      "color": "#ffce17",
      "id": "2",
      "name": "Banu"
    },
    {
      "code": "VNCL",
      "color": "#bd002d",
      "id": "3",
      "name": "Vanduul"
    },
    {
      "code": "XIAN",
      "color": "#52c231",
      "id": "4",
      "name": "Xi'An"
    },
    {
      "code": "DEV",
      "color": "#ca922d",
      "id": "7",
      "name": "Developing"
    },
    {
      "code": "UNC",
      "color": "#f6851f",
      "id": "8",
      "name": "Unclaimed"
    }
  ]
}

Query Parameters

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

• mode – live , cache , auto or eager .

Parameters

• name ( str ) – the name of the affiliations to search.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.15. Starmap Object

GET / ( string: apikey ) /v1/ ( string: mode ) /starmap/object

Get the starmap object’s info using its code

The code of the object can be obtained using the Starmap Object

Example request :

GET /xxxxxxxx/v1/live/starmap/object?code=STANTON.PLANETS.STANTONIICRUSADER 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": "live",
  "data": {
    "affiliation": [

    ],
    "age": "0.00000000",
    "appearance": "PLANET_GAS",
    "axial_tilt": "0.00000000",
    "children": [

    ],
    "code": "STANTON.PLANETS.STANTONIICRUSADER",
    "description": "A low mass gas giant that features a breathable atmosphere at high altitudes. This was an ideal situation for ship manufacturer Crusader, who now occupies the planet\u2019s floating platforms to build massive ships like the Starliner.",
    "designation": "Stanton II",
    "distance": "1.28000000",
    "fairchanceact": null,
    "habitable": "1",
    "id": "1695",
    "info_url": null,
    "latitude": "0.00000000",
    "longitude": "-160.00000000",
    "name": "Crusader",
    "orbit_period": "534.63000000",
    "parent_id": "1691",
    "population": [],
    "sensor_danger": "5",
    "sensor_economy": "8",
    "sensor_population": "4",
    "shader_data": null,
    "show_label": "1",
    "show_orbitlines": "1",
    "size": "74500.00000000",
    "subtype": {
      "id": "23",
      "name": "Gas Giant",
      "type": "PLANET"
    },
    "subtype_id": "23",
    "texture": {

    },
    "time_modified": "2018-01-27 01:37:21",
    "type": "PLANET"
  }
}

Query Parameters

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

• mode – live , cache , auto or eager .

Parameters

• code ( str ) – the code of the objects to search.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.16. Starmap Star System

GET / ( string: apikey ) /v1/ ( string: mode ) /starmap/star-system

Get the star-system info using its code

The code of the object can be obtained using the Starmap Object

Example request :

GET /xxxxxxxx/v1/live/starmap/star-system?code=STANTON 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": "live",
  "data": {
    "affiliation": [

    ],
    "aggregated_danger": 10,
    "aggregated_economy": 10,
    "aggregated_population": 10,
    "aggregated_size": "4.85000000",
    "celestial_objects": [

    ],
    "code": "STANTON",
    "description": "While the UEE still controls the rights to the system overall, the four planets themselves were sold by the government to four megacorporations making them the only privately-owned worlds in the Empire. Though subject to the UEE\u2019s Common Laws and standard penal code, the UEE does not police the region. Instead, private planetary security teams enforce the local law.",
    "frost_line": "4.96000000",
    "habitable_zone_inner": "0.89000000",
    "habitable_zone_outer": "3.00000000",
    "id": "314",
    "info_url": null,
    "name": "Stanton",
    "position_x": "49.53471800",
    "position_y": "-2.63396450",
    "position_z": "16.47529200",
    "shader_data": {

    },
    "status": "P",
    "thumbnail": {

    },
    "time_modified": "2018-01-27 01:36:42",
    "type": "SINGLE_STAR"
  }
}

Query Parameters

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

• mode – live , cache , auto or eager .

Parameters

• code ( str ) – the code of the star-system to search.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.

1.17. Starmap Searches

GET / ( string: apikey ) /v1/ ( string: mode ) /starmap/search

Get any objects in the starmap that match the search

Example request :

GET /xxxxxxxx/v1/live/starmap/search?name=Crusader 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": "live",
  "data": {
    "objects": [
      {
        "code": "STANTON.PLANETS.STANTONIICRUSADER",
        "designation": "Stanton II",
        "id": "1695",
        "name": "Crusader",
        "star_system": {
          "code": "STANTON",
          "id": "314",
          "name": "Stanton",
          "type": "SINGLE_STAR"
        },
        "star_system_id": "314",
        "status": "P",
        "type": "PLANET"
      }
    ],
    "systems": []
  }
}

Query Parameters

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

• mode – live .

Parameters

• name ( str ) – the name of the objects to search.

Status Codes

• 200 OK – success.

• 404 Not Found – error in the query.