Get Imperial Fleet Data

Returns all Star Destroyers from the Imperial Fleet that the user has clearance to access

GET /fleet/star-destroyers

Get Imperial Fleet Data

cURL

curl --request GET \
  --url https://api.empire.gov/v1/fleet/star-destroyers \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.empire.gov/v1/fleet/star-destroyers"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.empire.gov/v1/fleet/star-destroyers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.empire.gov/v1/fleet/star-destroyers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.empire.gov/v1/fleet/star-destroyers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.empire.gov/v1/fleet/star-destroyers")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.empire.gov/v1/fleet/star-destroyers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "status": "success",
  "data": {
    "vessels": [
      {
        "id": "ISD-001",
        "name": "Devastator",
        "length": "1,600 meters",
        "crew": 47000,
        "commander": "Captain Bolvan",
        "sector": "Outer Rim"
      }
    ],
    "total_count": 123,
    "page": 123,
    "per_page": 123
  }
}

{
  "error": 123,
  "message": "<string>",
  "error_code": "ASSET_ACCESS_DENIED"
}

{
  "error": 123,
  "message": "<string>",
  "error_code": "ASSET_ACCESS_DENIED"
}

This endpoint is currently in development. The example below shows placeholder data that demonstrates the expected response format.

Endpoint Overview

This endpoint will provide access to Imperial Fleet vessel information. Full functionality and real data will be available once the API is officially deployed.

Example Endpoint: GET /api/v1/fleet/star-destroyers

Placeholder Response

The following is an example of what the response might look like when accessing Imperial fleet data:

{
  "status": "success",
  "data": {
    "vessels": [
      {
        "id": "ISD-001",
        "name": "Devastator",
        "class": "Imperial I-class Star Destroyer",
        "length": "1,600 meters",
        "crew": 47000,
        "commander": "Captain Bolvan",
        "sector": "Outer Rim",
        "status": "operational"
      },
      {
        "id": "ISD-002",
        "name": "Avenger",
        "class": "Imperial II-class Star Destroyer",
        "length": "1,600 meters",
        "crew": 37000,
        "commander": "Captain Needa",
        "sector": "Mid Rim",
        "status": "operational"
      }
    ],
    "total_count": 25000,
    "page": 1,
    "per_page": 2
  }
}

Actual fleet data is classified. This is demonstration data only.

Authorizations

Authorization · string · header · required

Imperial Command authorisation token. Contact your commanding officer for access credentials.

Query Parameters

limit · integer<int32> · default: 10

The maximum number of vessels to return

Required range: x <= 100

sector · enum<string>

Filter by galactic sector

Available options: Outer Rim, Mid Rim, Inner Rim, Core Worlds

Response

200

application/json

Fleet data response

status · string

Example:

"success"

data · object

Show child attributes