FleetYards.net API v1

API Endpoint

https://api.fleetyards.net

“Strap into one of dozens of ships and embark on a life within the Star Citizen universe. Unbound by profession or skill sets, you choose the path of your own life.”

This API provides basic Information about All Ships / Components / Manufacturers for the upcomming Space Simulation Star Citizen.

NOTE: This document is a work in progress.

Current Version

The Current Version is v1 and is included in each Request like this:

https://api.fleetyards.net/v1/ships

Schema

All API access is over HTTPS, and accessed from the https://api.fleetyards.net. All data is sent and received as JSON.

Blank fields are included as null instead of being omitted.

Timestamps

All timestamps return in ISO 8601 format:

YYYY-MM-DDTHH:MM:SSZ

Summary Representations

When you fetch a list of resources, the response includes a subset of the attributes for that resource. This is the “summary” representation of the resource.

Example: When you get a list of models, you get the summary representation of each model:

GET /v1/models

Detailed Representations

When you fetch an individual resource, the response typically includes all attributes for that resource. This is the “detailed” representation of the resource.

Example: When you get an individual model, you get the detailed representation of the model. Here, we fetch Origins 300i repository:

GET /v1/models/300i

The documentation provides an example response for each API method. The example response illustrates all attributes that are returned by that method.

Client Errors

Authentication

Pagination

Requests that return multiple items will be paginated to 30 items by default. You can specify further pages with the ?page parameter. For some resources, you can also set a custom page size up to 200 with the ?perPage parameter. Note that for technical reasons not all endpoints respect the ?perPage parameter, see events for example.

curl ’https://api.fleetyards.net/models?page=2&perPage=200’ Note that page numbering is 1-based and that omitting the ?page parameter will return the first page.

Link Header

The Link header includes pagination information:

Link: <https://api.fleetyards.net/models?page=1&perPage=200>; rel="next",
  <https://api.fleetyards.net/models?page=2&perPage=200>; rel="last"

The example includes a line break for readability.

This Link response header contains one or more Hypermedia link relations, some of which may require expansion as URI templates.

The possible rel values are:

Name	Description
next	The link relation for the immediate next page of results.
last	The link relation for the last page of results.
first	The link relation for the first page of results.
prev	The link relation for the immediate previous page of results.

Rate Limiting

Embed Fleetview ¶

Setup

To get a custom Ship List on your Website you can just paste the example code on the right side at the position where you want to render a Ship List.

<div id="fleetyards-view"></div>
<script>
    window.FleetYardsFleetchartConfig = {  
        details: true, // Set to false if you want to display a minimal version of the Ship Panel
        grouped: true, // Set to false if you want to display the same Ships multiple times in your Fleetview.
        fleetchart: false, // Set to true if you want to display a Fleetchart instead of the normal Ship Panels.
        fleetchartGrouped: false, // Set to true if you want to group the Ships on the Fleetchart View or not.
        fleetchartScale: 50, // Initial Scale of the Fleetchart
        groupedButton: false, // Allow the User to toggle Groupped Views
        fleetchartSlider: false, // Set to true to display a slider which allows users to scale the Fleetchart
        ships: ['100i', '300i', '600i-touring', '890-jump'], // Replace the Array with a List of Shipnames (slugs) you want to display,
        users: ['torlekmaru', 'johndoe'], // Replace the Array with a list of Fleetyards.net usernames, alternative to the ships option.
        fleetId: 'maru', // Replace the value with a your Fleetyards.net fleet id, alternative to the ships option.
    };
    (function() {
        var d = document, s = d.createElement('script');
        s.src = 'https://fleetyards.net/embed-v2.js#' + new Date().getTime();
        (d.head || d.body).appendChild(s);
    })();
</script>
<noscript>Please enable JavaScript to view your custom Fleetview powered by FleetYards.net.</noscript>

Options

Show Details

details: true|false (boolean) default is true

Display details about the given Ship or just a minimal version.

Grouped View

grouped: true|false (boolean) default is true

Group duplicated Ships and Show a count on each Ship Panel.

Render as Fleetchart

fleetchart: true|false (boolean) default is false

Display the Fleetview as a Fleetchart with correct Ship Dimensions.

Grouped View for Fleetchart

fleetchartGrouped: true|false (boolean) default is false

Group duplicated Ships in the Fleetchart

Initial Fleetchart Scale

fleetchartScale: 50 (int) default is 50

Set the initial Scale of the Fleetchart, can be between 10 - 300 for Desktop and 10 - 100 for Mobile.

Show Fleetchart Slider

fleetchartSlider: true|false (boolean) default is false

Display a slider to allow users to scale the Fleetchart.

Ships List

ships: [] (Array of Strings) default is []

The Fleetview expects a List of Shipnames (slugs). If you want to have Ships multiple times in the Fleetview just add them multiple times to the list. To be able to resolve the correct Ships from the Fleetyards.net API you need to provide every Shipname (slug) in the correct Format.

You can use the Following Mapping to find out what the slug looks like for each Ship:

{
    "100i": "100i",
    "125a": "125a",
    "135c": "135c",
    "300i": "300i",
    "315p": "315p",
    "325a": "325a",
    "350r": "350r",
    "600i Explorer": "600i-explorer",
    "600i Touring": "600i-touring",
    "85X": "85x",
    "890 Jump": "890-jump",
    "A2 Hercules": "a2-hercules",
    "Apollo Medivac": "apollo-medivac",
    "Apollo Triage": "apollo-triage",
    "Aurora CL": "aurora-cl",
    "Aurora ES": "aurora-es",
    "Aurora LN": "aurora-ln",
    "Aurora LX": "aurora-lx",
    "Aurora MR": "aurora-mr",
    "Avenger Stalker": "avenger-stalker",
    "Avenger Titan": "avenger-titan",
    "Avenger Titan Renegade": "avenger-titan-renegade",
    "Avenger Warlock": "avenger-warlock",
    "Blade": "blade",
    "Buccaneer": "buccaneer",
    "C2 Hercules": "c2-hercules",
    "Carrack": "carrack",
    "Caterpillar": "caterpillar",
    "Caterpillar Pirate Edition": "caterpillar-pirate-edition",
    "Constellation Andromeda": "constellation-andromeda",
    "Constellation Aquila": "constellation-aquila",
    "Constellation Phoenix": "constellation-phoenix",
    "Constellation Phoenix Emerald": "constellation-phoenix-emerald",
    "Constellation Taurus": "constellation-taurus",
    "Crucible": "crucible",
    "Cutlass Black": "cutlass-black",
    "Cutlass Blue": "cutlass-blue",
    "Cutlass Red": "cutlass-red",
    "Cyclone": "cyclone",
    "Cyclone-AA": "cyclone-aa",
    "Cyclone-RC": "cyclone-rc",
    "Cyclone-RN": "cyclone-rn",
    "Cyclone-TR": "cyclone-tr",
    "Defender": "defender",
    "Dragonfly Black": "dragonfly-black",
    "Dragonfly Starkitten Edition": "dragonfly-starkitten-edition",
    "Dragonfly Yellowjacket": "dragonfly-yellowjacket",
    "Eclipse": "eclipse",
    "Endeavor": "endeavor",
    "F7A Hornet": "f7a-hornet",
    "F7C Hornet": "f7c-hornet",
    "F7C Hornet Wildfire": "f7c-hornet-wildfire",
    "F7C-M Super Hornet": "f7c-m-super-hornet",
    "F7C-R Hornet Tracker": "f7c-r-hornet-tracker",
    "F7C-S Hornet Ghost": "f7c-s-hornet-ghost",
    "F8C": "f8c",
    "F8C Executive": "f8c-executive",
    "Freelancer": "freelancer",
    "Freelancer DUR": "freelancer-dur",
    "Freelancer MAX": "freelancer-max",
    "Freelancer MIS": "freelancer-mis",
    "Genesis Starliner": "genesis-starliner",
    "Geotack Planetary Beacon": "geotack-planetary-beacon",
    "Geotack-X Planetary Beacon": "geotack-x-planetary-beacon",
    "Gladiator": "gladiator",
    "Gladius": "gladius",
    "Gladius Valiant": "gladius-valiant",
    "Glaive": "glaive",
    "Hammerhead": "hammerhead",
    "Hawk": "hawk",
    "Herald": "herald",
    "Hull A": "hull-a",
    "Hull B": "hull-b",
    "Hull C": "hull-c",
    "Hull D": "hull-d",
    "Hull E": "hull-e",
    "Hurricane": "hurricane",
    "Idris-M": "idris-m",
    "Idris-P": "idris-p",
    "Javelin": "javelin",
    "Khartu-Al": "khartu-al",
    "M2 Hercules": "m2-hercules",
    "M50": "m50",
    "MPUV Cargo": "mpuv-cargo",
    "MPUV Personnel": "mpuv-personnel",
    "Merchantman": "merchantman",
    "Mustang Alpha": "mustang-alpha",
    "Mustang Beta": "mustang-beta",
    "Mustang Delta": "mustang-delta",
    "Mustang Gamma": "mustang-gamma",
    "Mustang Omega": "mustang-omega",
    "Nova Tank": "nova-tank",
    "Nox": "nox",
    "Nox Kue": "nox-kue",
    "Orion": "orion",
    "P52 Merlin": "p52-merlin",
    "P72 Archimedes": "p72-archimedes",
    "PTV": "ptv",
    "Pioneer": "pioneer",
    "Polaris": "polaris",
    "Prospector": "prospector",
    "Prowler": "prowler",
    "Razor": "razor",
    "Razor EX": "razor-ex",
    "Razor LX": "razor-lx",
    "Reclaimer": "reclaimer",
    "Redeemer": "redeemer",
    "Reliant Kore": "reliant-kore",
    "Reliant Mako": "reliant-mako",
    "Reliant Sen": "reliant-sen",
    "Reliant Tana": "reliant-tana",
    "Retaliator Base": "retaliator-base",
    "Retaliator Bomber": "retaliator-bomber",
    "Sabre": "sabre",
    "Sabre Comet": "sabre-comet",
    "Sabre Raven": "sabre-raven",
    "Scythe": "scythe",
    "Starfarer": "starfarer",
    "Starfarer Gemini": "starfarer-gemini",
    "Terrapin": "terrapin",
    "Ursa Rover": "ursa-rover",
    "Vanguard Harbinger": "vanguard-harbinger",
    "Vanguard Hoplite": "vanguard-hoplite",
    "Vanguard Sentinel": "vanguard-sentinel",
    "Vanguard Warden": "vanguard-warden",
    "Vulcan": "vulcan",
    "Vulture": "vulture",
    "X1 Base": "x1-base",
    "X1 Force": "x1-force",
    "X1 Velocity": "x1-velocity"
}

Please use https://www.fleetyards.net/ships or call the Fleetyards.net API /v1/models to fetch the latest Shipnames.

Users List

users: [] (Array of Strings) default is []

As an alternative to the Ships List you can also provide a list of Fleetyards usernames. You will than get a list of all Ships those Users have in there public Hangar.

Models ¶

GET https://api.fleetyards.net/v1/models

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
    {
        "id": "719f60e4-ae48-4941-80f1-17528fd7dd06",
        "name": "100i",
        "rsiName": "100i",
        "slug": "100i",
        "rsiSlug": "100i",
        "description": "Tour the universe with the perfect coupling of luxury and performance. The 100i features Origin Jumpworks' patented AIR fuel system, making it the most efficient and eco-friendly ship on the market. Capable of long distance flights that most ships of its size aren't equipped for, the 100i is perfect for solo pilots looking to turn heads without sacrificing functionality or reliability.",
        "length": 15,
        "beam": 10,
        "height": 4,
        "mass": 0,
        "cargo": 2,
        "cargoLabel": "100i (2 SCU)",
        "minCrew": 1,
        "maxCrew": 1,
        "scmSpeed": "210.0",
        "afterburnerSpeed": null,
        "groundSpeed": null,
        "afterburnerGroundSpeed": null,
        "pitchMax": null,
        "yawMax": null,
        "rollMax": null,
        "xaxisAcceleration": null,
        "yaxisAcceleration": null,
        "zaxisAcceleration": null,
        "size": "small",
        "sizeLabel": "Small",
        "storeImage": "http://api.fleetyards.test/uploads/model/store_image/719f60e4-ae48-4941-80f1-17528fd7dd06/100i.jpg",
        "fleetchartImage": "http://api.fleetyards.test/uploads/model/fleetchart_image/719f60e4-ae48-4941-80f1-17528fd7dd06/100i.png",
        "backgroundImage": "http://api.fleetyards.test/uploads/image/name/1c6093b0-7dad-498a-bb4e-a3d12a843990/ORIG_100i_Interior_design_Shot_AL03_CC-Min.jpg",
        "brochure": "http://api.fleetyards.test/uploads/model/brochure/719f60e4-ae48-4941-80f1-17528fd7dd06/Origin-100-Series-Brochure-FINAL.pdf",
        "storeUrl": "https://robertsspaceindustries.com/pledge/ships/origin-100/100i",
        "price": null,
        "pledgePrice": 40,
        "lastPledgePrice": 45,
        "onSale": false,
        "productionStatus": "in-concept",
        "productionNote": null,
        "classification": "multi",
        "classificationLabel": "Multi",
        "focus": "Starter/Touring",
        "rsiId": 159,
        "hasImages": true,
        "hasVideos": false,
        "manufacturer": {
            "name": "Origin Jumpworks GmbH",
            "slug": "origin-jumpworks-gmbh",
            "code": "ORIG",
            "logo": "http://api.fleetyards.test/uploads/manufacturer/logo/4052e7cf-5451-4a9f-a7e2-797daa26ccd8/small_Origin.png"
        },
        "createdAt": "2018-04-13T21:16:02+02:00",
        "updatedAt": "2018-05-02T08:31:16+02:00"
    },
    ...
]

GET List
GET`/v1/models`

Get a List of Models

Models ¶

GET https://api.fleetyards.net/v1/models/slugs

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
  "eclipse",
  "mercury-star-runner",
  "geotack-x-planetary-beacon",
  "avenger-warlock",
  "avenger-titan-renegade",
  "avenger-titan",
  "hurricane",
  "blade",
  "cutlass-black",
  "avenger-stalker",
  "600i-explorer",
  "gladius",
  "reclaimer",
  "f7c-r-hornet-tracker",
  "razor",
  "reliant-sen",
  "dragonfly-black",
  "f7c-m-super-hornet",
  "nox-kue",
  "mpuv-cargo",
  "m50",
  "vulture",
  "endeavor",
  "cyclone-aa",
  "hammerhead",
  "freelancer-mis",
  "f8c",
  "buccaneer",
  "prowler",
  "hull-a",
  "p52-merlin",
  "hawk",
  "hull-c",
  "x1-velocity",
  "retaliator-bomber",
  "carrack",
  "scythe",
  "crucible",
  "f7c-hornet-wildfire",
  "redeemer",
  "ptv",
  "300i",
  "khartu-al",
  "315p",
  "constellation-aquila",
  "aurora-lx",
  "gladius-valiant",
  "reliant-mako",
  "reliant-tana",
  "x1-force",
  "idris-m",
  "cyclone-rc",
  "p72-archimedes",
  "constellation-taurus",
  "mpuv-personnel",
  "cyclone",
  "325a",
  "constellation-phoenix",
  "genesis-starliner",
  "sabre-comet",
  "razor-ex",
  "nox",
  "cyclone-tr",
  "350r",
  "idris-p",
  "javelin",
  "sabre",
  "herald",
  "cyclone-rn",
  "polaris",
  "vanguard-warden",
  "f7a-hornet",
  "freelancer-max",
  "pioneer",
  "890-jump",
  "apollo-triage",
  "nova",
  "85x",
  "x1-base",
  "glaive",
  "merchantman",
  "starfarer-gemini",
  "sabre-raven",
  "dragonfly-yellowjacket",
  "gladiator",
  "ursa-rover",
  "freelancer",
  "freelancer-dur",
  "hull-e",
  "f7c-hornet",
  "aurora-cl",
  "hull-b",
  "constellation-andromeda",
  "100i",
  "vanguard-harbinger",
  "aurora-mr",
  "razor-lx",
  "m2-hercules",
  "f8c-executive",
  "135c",
  "aurora-es",
  "aurora-ln",
  "dragonfly-starkitten-edition",
  "125a",
  "vulcan",
  "terrapin",
  "vanguard-hoplite",
  "hull-d",
  "a2-hercules",
  "c2-hercules",
  "mustang-delta",
  "mustang-alpha-vindicator",
  "geotack-planetary-beacon",
  "mustang-alpha",
  "valkyrie-liberator-edition",
  "mustang-gamma",
  "mustang-beta",
  "mustang-omega",
  "prospector",
  "apollo-medivac",
  "cutlass-blue",
  "cutlass-red",
  "kraken",
  "starfarer",
  "caterpillar-pirate-edition",
  "vanguard-sentinel",
  "orion",
  "constellation-phoenix-emerald",
  "arrow",
  "defender",
  "valkyrie",
  "reliant-kore",
  "f7c-s-hornet-ghost",
  "600i-touring",
  "caterpillar",
  "idris-k",
  "san-tok-yai",
  "retaliator-base"
]

GET List
GET`/v1/models/slugs`

Get a List of all current Model slugs

Models ¶

GET https://api.fleetyards.net/v1/models/latest

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

GET Latest
GET`/v1/models/latest`

Get the last 20 Models ordered by updatedAt

The Response Body is identical to /v1/models

Filters ¶

GET https://api.fleetyards.net/v1/models/filters

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
    {
        "name": "Combat",
        "value": "combat",
        "category": "classification",
        "icon": null
    },
    ...
    {
        "name": "Medium cargo/medium data",
        "value": "Medium Cargo/Medium Data",
        "category": "focus",
        "icon": null
    },
    ...
    {
        "name": "ARGO Astronautics",
        "value": "argo-astronautics",
        "category": "manufacturer",
        "icon": "http://api.fleetyards.test/uploads/manufacturer/logo/ff6dc660-7caf-454d-9e4a-2050cfac632e/small_Argo.png"
    },
    ...
    {
        "name": "Announced",
        "value": "announced",
        "category": "productionStatus",
        "icon": null
    },
    ...
    {
        "name": "Capital",
        "value": "capital",
        "category": "size",
        "icon": null
    },
    ...
]

GET Filters
GET`/v1/models/filters`

Get all available Model Filters with Options

Categories

Model Filters belong to one of 4 different Filter Categories:

classification
focus
manufacturer
productionStatus
size

All these Filters can also be fetched directly via /v1/models/:category

Model ¶

GET https://api.fleetyards.net/v1/models/600i-explorer

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

{
    "id": "bd062120-034e-4bdc-a979-9b02644b5f3c",
    "name": "600i Explorer",
    "rsiName": "600i Explorer",
    "slug": "600i-explorer",
    "rsiSlug": "600i-explorer",
    "description": "Let the voyage begin with the 2947 600i from Origin Jumpworks. This multi-role luxury vessel from Origin Jumpworks features an exquisitely detailed hull design that balances performance and versatility in a sleek and timeless form. The 600i is designed with a cutting-edge modular technology, allowing you to customize your ship for your needs. Looking to stamp your name in history with the discovery of a new star system? The 600i's Explorer module swaps the lounge for a robust scanning station as well as additional utility hardpoints to increase the ship's effectiveness even more.",
    "length": 91.5,
    "beam": 52,
    "height": 17,
    "mass": 1576792,
    "cargo": 40,
    "cargoLabel": "600i Explorer (40 SCU)",
    "minCrew": 2,
    "maxCrew": 5,
    "scmSpeed": "145.0",
    "afterburnerSpeed": "975.0",
    "groundSpeed": null,
    "afterburnerGroundSpeed": null,
    "pitchMax": "30.0",
    "yawMax": "30.0",
    "rollMax": "50.0",
    "xaxisAcceleration": "15.6",
    "yaxisAcceleration": "21.6",
    "zaxisAcceleration": "18.1",
    "size": "large",
    "sizeLabel": "Large",
    "storeImage": "http://api.fleetyards.test/uploads/model/store_image/bd062120-034e-4bdc-a979-9b02644b5f3c/600i-Exploration-1503514950.jpg",
    "fleetchartImage": "http://api.fleetyards.test/uploads/model/fleetchart_image/bd062120-034e-4bdc-a979-9b02644b5f3c/ORIG_-_600i__Concept__Correct_Size_-1519582284.png",
    "backgroundImage": "http://api.fleetyards.test/uploads/image/name/e05f20aa-0671-4cbc-906b-e45c3fb69424/Tohil_jumppoint_02-slim.jpg",
    "brochure": "http://api.fleetyards.test/uploads/model/brochure/bd062120-034e-4bdc-a979-9b02644b5f3c/origin600i-brochure-optimised.pdf",
    "storeUrl": "https://robertsspaceindustries.com/pledge/ships/600i/600i-Explorer",
    "price": null,
    "pledgePrice": 435,
    "lastPledgePrice": 475,
    "onSale": false,
    "productionStatus": "flight-ready",
    "productionNote": null,
    "classification": "exploration",
    "classificationLabel": "Exploration",
    "focus": "Expedition",
    "rsiId": 141,
    "hasImages": true,
    "hasVideos": true,
    "manufacturer": {
        "name": "Origin Jumpworks GmbH",
        "slug": "origin-jumpworks-gmbh",
        "code": "ORIG",
        "logo": "http://api.fleetyards.test/uploads/manufacturer/logo/4052e7cf-5451-4a9f-a7e2-797daa26ccd8/small_Origin.png"
    },
    "hardpoints": [
        ...
        {
            "id": "8a240e5d-3eb9-48cd-9dcf-485a083181f0",
            "type": "turrets",
            "class": "RSIWeapon",
            "size": "2",
            "quantity": 2,
            "mounts": 2,
            "details": "Remote",
            "category": null,
            "defaultEmpty": false,
            "component": {
                "id": "bdf84ac0-cee9-47bc-8075-7740278ef51e",
                "name": "CF-227 Badger Laser Repeater",
                "slug": "cf-227-badger-laser-repeater",
                "size": "2",
                "class": "RSIWeapon",
                "type": "turrets",
                "manufacturer": {
                    "name": "Klaus &amp; Werner",
                    "slug": "klaus-amp-werner",
                    "code": null,
                    "logo": null
                }
            }
        },
        ...
    ],
    "images": [
        {
            "id": "21b3cb34-983b-43c6-93dc-d2f98b4c7762",
            "name": "Macro-Semi-Back.jpg",
            "url": "http://api.fleetyards.test/uploads/image/name/21b3cb34-983b-43c6-93dc-d2f98b4c7762/Macro-Semi-Back.jpg",
            "width": 2000,
            "height": 1000,
            "type": "image/jpeg",
            "background": true,
            "smallUrl": "http://api.fleetyards.test/uploads/image/name/21b3cb34-983b-43c6-93dc-d2f98b4c7762/small_Macro-Semi-Back.jpg",
            "bigUrl": "http://api.fleetyards.test/uploads/image/name/21b3cb34-983b-43c6-93dc-d2f98b4c7762/big_Macro-Semi-Back.jpg"
        },
        ...
    ],
    "videos": [
        {
            "id": "6c5f649c-a7a6-45ee-a9b4-9881795f6af8",
            "url": "https://www.youtube.com/embed/gbCSQDhPOlk",
            "videoId": "gbCSQDhPOlk",
            "type": "youtube",
            "createdAt": "2017-08-28T23:46:01+02:00",
            "updatedAt": "2018-05-06T21:50:00+02:00"
        }
    ],
    "createdAt": "2017-08-25T23:16:40+02:00",
    "updatedAt": "2018-07-17T09:01:07+02:00"
}

GET Detail
GET`/v1/models/{slug}`

Get Detail of a Model referenced by its Slug

URI Parameters

HideShow

slug: string (required) Example: 600i-explorer
The Model Slug

Model ¶

GET https://api.fleetyards.net/v1/models/cutlass-black/images

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
  {
    "id": "67438138-d329-43af-b64c-ced601927a3a",
    "name": "1486925107.jpg",
    "url": "http://api.fleetyards.test/uploads/image/name/67438138-d329-43af-b64c-ced601927a3a/1486925107.jpg",
    "width": 827,
    "height": 344,
    "type": "image/jpeg",
    "background": true,
    "smallUrl": "http://api.fleetyards.test/uploads/image/name/67438138-d329-43af-b64c-ced601927a3a/small_1486925107.jpg",
    "bigUrl": "http://api.fleetyards.test/uploads/image/name/67438138-d329-43af-b64c-ced601927a3a/big_1486925107.jpg",
    "model": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "gallery": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "createdAt": "2017-10-19T23:45:35+02:00",
    "updatedAt": "2017-10-27T14:19:07+02:00"
  },
  {
    "id": "0752ca78-1a3f-4c1c-9b26-d57cb35681d3",
    "name": "1486925107__2_.jpg",
    "url": "http://api.fleetyards.test/uploads/image/name/0752ca78-1a3f-4c1c-9b26-d57cb35681d3/1486925107__2_.jpg",
    "width": 879,
    "height": 344,
    "type": "image/jpeg",
    "background": true,
    "smallUrl": "http://api.fleetyards.test/uploads/image/name/0752ca78-1a3f-4c1c-9b26-d57cb35681d3/small_1486925107__2_.jpg",
    "bigUrl": "http://api.fleetyards.test/uploads/image/name/0752ca78-1a3f-4c1c-9b26-d57cb35681d3/big_1486925107__2_.jpg",
    "model": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "gallery": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "createdAt": "2017-10-19T23:45:35+02:00",
    "updatedAt": "2017-10-27T14:19:07+02:00"
  },
  {
    "id": "e2abace5-1839-46ac-9c73-3337a823b83b",
    "name": "1486925107__1_.jpg",
    "url": "http://api.fleetyards.test/uploads/image/name/e2abace5-1839-46ac-9c73-3337a823b83b/1486925107__1_.jpg",
    "width": 736,
    "height": 344,
    "type": "image/jpeg",
    "background": true,
    "smallUrl": "http://api.fleetyards.test/uploads/image/name/e2abace5-1839-46ac-9c73-3337a823b83b/small_1486925107__1_.jpg",
    "bigUrl": "http://api.fleetyards.test/uploads/image/name/e2abace5-1839-46ac-9c73-3337a823b83b/big_1486925107__1_.jpg",
    "model": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "gallery": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "createdAt": "2017-10-19T23:45:35+02:00",
    "updatedAt": "2017-10-27T14:19:08+02:00"
  },
  {
    "id": "6bf13569-1071-419e-b307-3f23bd8dd034",
    "name": "Drake_Cutlass_Black_InFlight-Copy.jpg",
    "url": "http://api.fleetyards.test/uploads/image/name/6bf13569-1071-419e-b307-3f23bd8dd034/Drake_Cutlass_Black_InFlight-Copy.jpg",
    "width": 4000,
    "height": 1938,
    "type": "image/jpeg",
    "background": true,
    "smallUrl": "http://api.fleetyards.test/uploads/image/name/6bf13569-1071-419e-b307-3f23bd8dd034/small_Drake_Cutlass_Black_InFlight-Copy.jpg",
    "bigUrl": "http://api.fleetyards.test/uploads/image/name/6bf13569-1071-419e-b307-3f23bd8dd034/big_Drake_Cutlass_Black_InFlight-Copy.jpg",
    "model": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "gallery": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "createdAt": "2017-10-19T23:38:24+02:00",
    "updatedAt": "2017-10-27T14:19:07+02:00"
  },
  {
    "id": "8f6366ab-d161-41c7-9a2d-886c4c778c0a",
    "name": "maxresdefault.jpg",
    "url": "http://api.fleetyards.test/uploads/image/name/8f6366ab-d161-41c7-9a2d-886c4c778c0a/maxresdefault.jpg",
    "width": 1280,
    "height": 720,
    "type": "image/jpeg",
    "background": true,
    "smallUrl": "http://api.fleetyards.test/uploads/image/name/8f6366ab-d161-41c7-9a2d-886c4c778c0a/small_maxresdefault.jpg",
    "bigUrl": "http://api.fleetyards.test/uploads/image/name/8f6366ab-d161-41c7-9a2d-886c4c778c0a/big_maxresdefault.jpg",
    "model": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "gallery": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "createdAt": "2017-10-19T23:38:07+02:00",
    "updatedAt": "2017-10-27T14:19:07+02:00"
  },
  {
    "id": "a2fd3a43-bcf3-4d1e-bcb7-86b00621fca8",
    "name": "maxresdefault__1_.jpg",
    "url": "http://api.fleetyards.test/uploads/image/name/a2fd3a43-bcf3-4d1e-bcb7-86b00621fca8/maxresdefault__1_.jpg",
    "width": 1280,
    "height": 720,
    "type": "image/jpeg",
    "background": true,
    "smallUrl": "http://api.fleetyards.test/uploads/image/name/a2fd3a43-bcf3-4d1e-bcb7-86b00621fca8/small_maxresdefault__1_.jpg",
    "bigUrl": "http://api.fleetyards.test/uploads/image/name/a2fd3a43-bcf3-4d1e-bcb7-86b00621fca8/big_maxresdefault__1_.jpg",
    "model": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "gallery": {
      "id": "b94e105b-8b8c-47f0-975c-5e6a3d1a3134",
      "name": "Cutlass Black",
      "slug": "cutlass-black"
    },
    "createdAt": "2017-10-19T23:38:06+02:00",
    "updatedAt": "2017-10-27T14:19:08+02:00"
  }
]

GET Images
GET`/v1/models/{slug}/images`

Get Image List of a Model referenced by its Slug

URI Parameters

HideShow

slug: string (required) Example: cutlass-black
The Model Slug

Model ¶

GET https://api.fleetyards.net/v1/models/cutlass-black/videos

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
  {
    "id": "8e2cda2b-3960-4ac8-b2df-ad68b2551d21",
    "url": "https://www.youtube.com/embed/xd7ftF298iU",
    "videoId": "xd7ftF298iU",
    "type": "youtube",
    "createdAt": "2018-09-15T09:42:50+02:00",
    "updatedAt": "2018-09-15T09:42:50+02:00"
  }
]

GET Videos
GET`/v1/models/{slug}/videos`

Get Video List of a Model referenced by its Slug

URI Parameters

HideShow

slug: string (required) Example: cutlass-black
The Model Slug

Model ¶

GET https://api.fleetyards.net/v1/models/endeavor/modules

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[    
    {
        "id": "5e6f0588-f5bf-4ef9-b3b0-6f4a7f89f3c9",
        "name": "Bio Dome (2x1)",
        "description": "As long as Humanity expands outward into the galaxy, there will always be a need for the most basic elements that sustain it. The Endeavor’s biodome pods were designed to support ongoing agriculture operations, adapting and growing foodstuffs which can then be sold for a profit.",
        "pledgePrice": null,
        "storeImage": "http://api.fleetyards.test/uploads/model_module/store_image/5e6f0588-f5bf-4ef9-b3b0-6f4a7f89f3c9/Biodome_pod_only_store.jpg",
        "storeImageMedium": "http://api.fleetyards.test/uploads/model_module/store_image/5e6f0588-f5bf-4ef9-b3b0-6f4a7f89f3c9/medium_Biodome_pod_only_store.jpg",
        "storeImageSmall": "http://api.fleetyards.test/uploads/model_module/store_image/5e6f0588-f5bf-4ef9-b3b0-6f4a7f89f3c9/small_Biodome_pod_only_store.jpg",
        "productionStatus": "in-concept",
        "manufacturer": {
            "name": "Musashi Industrial &amp; Starflight Concern",
            "slug": "musashi-industrial-amp-starflight-concern",
            "code": "MISC",
            "logo": "http://api.fleetyards.test/uploads/manufacturer/logo/9c0435a4-43ed-4db0-b023-7b42deeabc54/small_MISC.png"
        },
        "createdAt": "2018-11-29T23:53:38+01:00",
        "updatedAt": "2018-12-01T10:36:51+01:00"
    }
    ...
]

GET Modules
GET`/v1/models/{slug}/modules`

Get Modules List of a Model referenced by its Slug

URI Parameters

HideShow

slug: string (required) Example: endeavor
The Model Slug

Model ¶

GET https://api.fleetyards.net/v1/models/300i/variants

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
    {
        "id": "44ebab77-3856-40da-9162-4774aa8c27f5",
        "name": "315p",
        "rsiName": "315p",
        "slug": "315p",
        "rsiSlug": "315p",
        "description": "Exploration is man's highest calling. Prepare to chart distant horizons with man's most sophisticated piece of technology, the ORIGIN 315p. Featuring a more robust power plant and a custom scanning package, exclusively designed by Chimera Communications.",
        "length": 23,
        "beam": 15.5,
        "height": 7,
        "mass": 46195.5,
        "cargo": 2,
        "cargoLabel": "315p (2 SCU)",
        "minCrew": 1,
        "maxCrew": 1,
        "scmSpeed": "275.0",
        "afterburnerSpeed": "1225.0",
        "groundSpeed": null,
        "afterburnerGroundSpeed": null,
        "pitchMax": "85.0",
        "yawMax": "85.0",
        "rollMax": "120.0",
        "xaxisAcceleration": "71.0",
        "yaxisAcceleration": "87.2",
        "zaxisAcceleration": "75.4",
        "size": "small",
        "sizeLabel": "Small",
        "storeImage": "http://api.fleetyards.test/uploads/model/store_image/44ebab77-3856-40da-9162-4774aa8c27f5/315p_storefront_visual-1450470009.jpg",
        "fleetchartImage": "http://api.fleetyards.test/uploads/model/fleetchart_image/44ebab77-3856-40da-9162-4774aa8c27f5/ORIG_-_315p-1519582123.png",
        "backgroundImage": "http://api.fleetyards.test/uploads/image/name/4322afdc-550a-429d-b72b-d9c56ef3a86e/315p.jpg",
        "brochure": null,
        "storeUrl": "https://robertsspaceindustries.com/pledge/ships/origin-300/315p",
        "price": null,
        "pledgePrice": 65,
        "lastPledgePrice": 65,
        "onSale": true,
        "productionStatus": "flight-ready",
        "productionNote": "Update Pass Scheduled",
        "classification": "exploration",
        "classificationLabel": "Exploration",
        "focus": "Pathfinder",
        "rsiId": 8,
        "hasImages": true,
        "hasVideos": false,
        "manufacturer": {
            "name": "Origin Jumpworks GmbH",
            "slug": "origin-jumpworks-gmbh",
            "code": "ORIG",
            "logo": "http://api.fleetyards.test/uploads/manufacturer/logo/4052e7cf-5451-4a9f-a7e2-797daa26ccd8/small_Origin.png"
        },
        "createdAt": "2014-10-04T23:45:33+02:00",
        "updatedAt": "2018-10-19T12:57:17+02:00"
    },
    ...
]

GET Variants
GET`/v1/models/{slug}/variants`

Get Variants List of a Model referenced by its Slug

URI Parameters

HideShow

slug: string (required) Example: 300i
The Model Slug

Components ¶

GET https://api.fleetyards.net/v1/components/categories

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
  {
    "name": "Propulsion",
    "slug": "propulsion"
  },
  {
    "name": "Ordnance",
    "slug": "ordnance"
  },
  {
    "name": "Modular",
    "slug": "modular"
  },
  {
    "name": "Avionics",
    "slug": "avionics"
  }
]

GET Component Categories
GET`/v1/components/categories`

Get all available Component Categories

Images ¶

Image ¶

GET https://api.fleetyards.net/v1/images

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
  {
    "id": "ae88e4ad-4b92-48dc-bcba-aa49f4f30438",
    "name": "600i-Front-4thrids.png",
    "url": "https://api.fleetyards.net/uploads/image/name/ae88e4ad-4b92-48dc-bcba-aa49f4f30438/600i-Front-4thrids.png",
    "type": "image/png",
    "small": {
      "url": "https://api.fleetyards.net/uploads/image/name/ae88e4ad-4b92-48dc-bcba-aa49f4f30438/small_600i-Front-4thrids.png"
    },
    "big": {
      "url": "https://api.fleetyards.net/uploads/image/name/ae88e4ad-4b92-48dc-bcba-aa49f4f30438/big_600i-Front-4thrids.png"
    },
    "dark": {
      "url": "https://api.fleetyards.net/uploads/image/name/ae88e4ad-4b92-48dc-bcba-aa49f4f30438/dark_600i-Front-4thrids.png"
    },
    "ship": {
      "id": "db264a17-16df-4ddb-81e2-27aa58b8d835",
      "name": "Origin 600i Explorer",
      "slug": "origin-600i-explorer"
    },
    "createdAt": "2017-08-30T23:27:08+02:00",
    "updatedAt": "2017-08-30T23:27:14+02:00"
  }
]

GET List
GET`/v1/images`

Get a List of Images

GET https://api.fleetyards.net/v1/images/random

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

GET Random
GET`/v1/images/random`

Get 14 random Images

The Response Body is identical to /v1/images

Sessions ¶

Session ¶

POST https://api.fleetyards.net/v1/sessions

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "login": "username or email",
  "password": "*****"
}

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "token": "JWT_TOKEN"
}

POST Create
POST`/v1/sessions`

Create a new Session

DELETE https://api.fleetyards.net/v1/sessions

Requestsexample 1

Headers

Content-Type: application/json
Authorization: Bearer JWT_TOKEN
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "code": "sessions.destroy",
  "message": "Signed out successfully."
}

DELETE Destroy
DELETE`/v1/sessions`

Destroy your current Session

Users ¶

Password ¶

Vehicles ¶

Hangar ¶

GET https://api.fleetyards.net/v1/vehicles

Requestsexample 1

Headers

Content-Type: application/json
Authorization: Bearer JWT
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
  {
    "id": "7089c581-c212-4f2e-8d47-8dc988963b5a",
    "name": "",
    "purchased": true,
    "flagship": false,
    "saleNotify": true,
    "public": true,
    "model": {
      "id": "0f7bb93d-c144-4cec-b4f7-17f520a01203",
      "name": "Freelancer MIS",
      "slug": "freelancer-mis",
      "description": "The Freelancer MIS is a limited edition militarized variant of the classic mercantile ship developed by the UEE. These were produced in very small quantity due to some early payload incidents. This version sacrifices the majority of the cargo capacity to make way for missiles. ",
      "length": "34.000",
      "beam": "15.000",
      "height": "8.000",
      "mass": "300",
      "cargo": "52",
      "netCargo": null,
      "crew": "3",
      "storeImage": "https://api.fleetyards.test/uploads/ship/store_image/0f7bb93d-c144-4cec-b4f7-17f520a01203/Freelancer_mis_storefront_visual.jpg",
      "storeUrl": "https://robertsspaceindustries.com/pledge/ships/misc-freelancer/Freelancer-MIS",
      "price": "0.0",
      "onSale": false,
      "productionStatus": "ready",
      "productionNote": "Update pass scheduled",
      "powerplantSize": 5,
      "shieldSize": 5,
      "classification": "fighter",
      "focus": "Militia",
      "rsiId": 33,
      "manufacturer": {
        "id": "9c0435a4-43ed-4db0-b023-7b42deeabc54",
        "name": "Musashi Industrial &amp; Starflight Concern"
      },
      "role": {
        "id": "3c8fe766-0798-434f-bf9a-7631e2447175",
        "name": "Militia"
      },
      "createdAt": "2014-10-04T23:47:25+02:00",
      "updatedAt": "2017-08-30T22:00:37+02:00"
    },
    "createdAt": "2017-01-03T19:47:37+01:00",
    "updatedAt": "2017-01-11T01:16:50+01:00"
  }
]

GET Vehicles
GET`/v1/vehicles`

Get your personal Vehicles

Public Hangar ¶

GET https://api.fleetyards.net/v1/vehicles/torlekmaru

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

GET Public Vehicles
GET`/v1/vehicles/{username}`

Get all public Vehicles by username

The Response is idenntical to the Private Vehicles Response /v1/vehicles but only purchased Ships are returned.

URI Parameters

HideShow

username: string (required) Example: torlekmaru
The FleetYards.net Username

Stations ¶

GET https://api.fleetyards.net/v1/stations

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
    {
        "name": "Teasa Spaceport",
        "slug": "teasa-spaceport",
        "location": "Lorville",
        "type": "spaceport",
        "typeLabel": "Spaceport",
        "storeImage": "http://api.fleetyards.test/uploads/station/store_image/10dfe5bb-9ec9-4e0a-81d4-0b43c2bb3531/teasa_spaceport.jpg",
        "description": null,
        "celestialObject": {
            "name": "Hurston",
            "slug": "hurston",
            "designation": "Stanton I",
            "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/35908b50-7f8e-4344-85e5-f14d98b2be54/hurston.png"
        },
        "starsystem": {
            "name": "Stanton",
            "slug": "stanton",
            "storeImage": "http://api.fleetyards.test/uploads/starsystem/store_image/17b3dde9-c594-4667-9fe7-07ce9ba83be0/stanton.jpg",
            "mapX": "59.766411599",
            "mapY": "48.460661345"
        },
        "shops": [],
        "docks": [],
        "habitations": [],
        "createdAt": "2018-10-26T20:19:21+02:00",
        "updatedAt": "2018-10-28T14:26:09+01:00"
    },
    {
        "name": "Port Olisar",
        "slug": "port-olisar",
        "location": "Orbit",
        "type": "hub",
        "typeLabel": "Hub",
        "storeImage": "http://api.fleetyards.test/uploads/station/store_image/95381bc5-66fc-433b-a016-e87be4b2d8c3/portolisar.jpg",
        "description": null,
        "celestialObject": {
            "name": "Crusader",
            "slug": "crusader",
            "designation": "Stanton II",
            "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/224e95de-367e-4904-aebc-b85c70d0a318/crusader.jpg"
        },
        "starsystem": {
            "name": "Stanton",
            "slug": "stanton",
            "storeImage": "http://api.fleetyards.test/uploads/starsystem/store_image/17b3dde9-c594-4667-9fe7-07ce9ba83be0/stanton.jpg",
            "mapX": "59.766411599",
            "mapY": "48.460661345"
        },
        "shops": [
            {
                "name": "Admin Office",
                "slug": "admin-office",
                "type": "admin",
                "typeLabel": "Admin Office",
                "rental": false,
                "buying": false,
                "selling": false,
                "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/df5ca457-331d-4b60-96dc-ce01e73bf592/admin_portolisar.jpg"
            },
            {
                "name": "Casaba Outlet",
                "slug": "casaba-outlet",
                "type": "clothing",
                "typeLabel": "Clothing Store",
                "rental": false,
                "buying": false,
                "selling": true,
                "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/8e4ea426-f6ac-4f06-b069-6ca6b336ec84/casaba_portolisar.jpg"
            },
            {
                "name": "Dumper's Depot",
                "slug": "dumper-s-depot",
                "type": "components",
                "typeLabel": "Components Store",
                "rental": false,
                "buying": false,
                "selling": false,
                "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/a3e69cfc-dde1-4429-9c62-c66789184e32/dumpers_depot_portolisar.jpg"
            },
            {
                "name": "Garrity Defense",
                "slug": "garrity-defense",
                "type": "armor",
                "typeLabel": "Armor Store",
                "rental": false,
                "buying": false,
                "selling": false,
                "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/0fedbdbe-96b1-4980-8bf9-30e62960c3cd/garrity_defense_portolisar.jpg"
            },
            {
                "name": "Live Fire Weapons",
                "slug": "live-fire-weapons",
                "type": "weapons",
                "typeLabel": "Weapons Store",
                "rental": false,
                "buying": false,
                "selling": false,
                "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/904f4aea-91d2-4f6b-a9bf-de08df2c47b5/live_fire_weapons_portolisar.jpg"
            }
        ],
        "docks": [
            {
                "size": "Small",
                "count": 32,
                "type": "landingpad",
                "typeLabel": "Landingpad"
            },
            {
                "size": "Medium",
                "count": 8,
                "type": "landingpad",
                "typeLabel": "Landingpad"
            },
            {
                "size": "Extra large",
                "count": 4,
                "type": "landingpad",
                "typeLabel": "Landingpad"
            }
        ],
        "habitations": [
            {
                "count": 64,
                "type": "container",
                "typeLabel": "Container"
            }
        ],
        "createdAt": "2018-10-26T20:19:20+02:00",
        "updatedAt": "2018-10-28T14:26:07+01:00"
    },
    ...
]

GET List
GET`/v1/stations`

Get a List of Stations

Station ¶

GET https://api.fleetyards.net/v1/stations/port-olisar

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "name": "Port Olisar",
  "slug": "port-olisar",
  "location": "Orbit",
  "type": "hub",
  "typeLabel": "Hub",
  "storeImage": "http://api.fleetyards.test/uploads/station/store_image/95381bc5-66fc-433b-a016-e87be4b2d8c3/portolisar.jpg",
  "description": null,
  "celestialObject": {
    "name": "Crusader",
    "slug": "crusader",
    "designation": "Stanton II",
    "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/224e95de-367e-4904-aebc-b85c70d0a318/crusader.jpg"
  },
  "starsystem": {
    "name": "Stanton",
    "slug": "stanton",
    "storeImage": "http://api.fleetyards.test/uploads/starsystem/store_image/17b3dde9-c594-4667-9fe7-07ce9ba83be0/stanton.jpg",
    "mapX": "59.766411599",
    "mapY": "48.460661345"
  },
  "shops": [
    {
      "name": "Admin Office",
      "slug": "admin-office",
      "type": "admin",
      "typeLabel": "Admin Office",
      "rental": false,
      "buying": false,
      "selling": false,
      "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/df5ca457-331d-4b60-96dc-ce01e73bf592/admin_portolisar.jpg"
    },
    {
      "name": "Casaba Outlet",
      "slug": "casaba-outlet",
      "type": "clothing",
      "typeLabel": "Clothing Store",
      "rental": false,
      "buying": false,
      "selling": true,
      "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/8e4ea426-f6ac-4f06-b069-6ca6b336ec84/casaba_portolisar.jpg"
    },
    {
      "name": "Dumper's Depot",
      "slug": "dumper-s-depot",
      "type": "components",
      "typeLabel": "Components Store",
      "rental": false,
      "buying": false,
      "selling": false,
      "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/a3e69cfc-dde1-4429-9c62-c66789184e32/dumpers_depot_portolisar.jpg"
    },
    {
      "name": "Garrity Defense",
      "slug": "garrity-defense",
      "type": "armor",
      "typeLabel": "Armor Store",
      "rental": false,
      "buying": false,
      "selling": false,
      "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/0fedbdbe-96b1-4980-8bf9-30e62960c3cd/garrity_defense_portolisar.jpg"
    },
    {
      "name": "Live Fire Weapons",
      "slug": "live-fire-weapons",
      "type": "weapons",
      "typeLabel": "Weapons Store",
      "rental": false,
      "buying": false,
      "selling": false,
      "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/904f4aea-91d2-4f6b-a9bf-de08df2c47b5/live_fire_weapons_portolisar.jpg"
    }
  ],
  "docks": [
    {
      "size": "Small",
      "count": 32,
      "type": "landingpad",
      "typeLabel": "Landingpad"
    },
    {
      "size": "Medium",
      "count": 8,
      "type": "landingpad",
      "typeLabel": "Landingpad"
    },
    {
      "size": "Extra large",
      "count": 4,
      "type": "landingpad",
      "typeLabel": "Landingpad"
    }
  ],
  "habitations": [
    {
      "count": 64,
      "type": "container",
      "typeLabel": "Container"
    }
  ],
  "images": [],
  "createdAt": "2018-10-26T20:19:20+02:00",
  "updatedAt": "2018-10-28T14:26:07+01:00"
}

GET Detail
GET`/v1/stations/{slug}`

Get Detail of a Station referenced by its Slug

URI Parameters

HideShow

slug: string (required) Example: port-olisar
The Station Slug

Shops ¶

GET https://api.fleetyards.net/v1/shops

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
    {
        "name": "Admin Office",
        "slug": "admin-office",
        "type": "admin",
        "typeLabel": "Admin Office",
        "rental": false,
        "buying": false,
        "selling": false,
        "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/25819e85-43bb-41cd-ac6e-fd6e8b5d70ba/hickes_admin.jpg",
        "station": {
            "name": "Hickes Research Outpost",
            "slug": "hickes-research-outpost"
        },
        "celestialObject": {
            "name": "Cellin",
            "slug": "cellin"
        },
        "createdAt": "2018-10-26T20:19:23+02:00",
        "updatedAt": "2018-10-28T21:43:29+01:00"
    },
    {
        "name": "Admin Office",
        "slug": "admin-office",
        "type": "admin",
        "typeLabel": "Admin Office",
        "rental": false,
        "buying": false,
        "selling": false,
        "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/df5ca457-331d-4b60-96dc-ce01e73bf592/admin_portolisar.jpg",
        "station": {
            "name": "Port Olisar",
            "slug": "port-olisar"
        },
        "celestialObject": {
            "name": "Crusader",
            "slug": "crusader"
        },
        "createdAt": "2018-10-26T20:19:20+02:00",
        "updatedAt": "2018-10-28T21:43:27+01:00"
    },
    ...
]

GET List
GET`/v1/shops`

Get a List of Shops

Shop ¶

GET https://api.fleetyards.net/v1/stations/port-olisar/shops/dumpers-depot

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "name": "Casaba Outlet",
  "slug": "casaba-outlet",
  "type": "clothing",
  "typeLabel": "Clothing Store",
  "rental": false,
  "buying": false,
  "selling": true,
  "storeImage": "http://api.fleetyards.test/uploads/shop/store_image/8e4ea426-f6ac-4f06-b069-6ca6b336ec84/casaba_portolisar.jpg",
  "station": {
    "name": "Port Olisar",
    "slug": "port-olisar"
  },
  "celestialObject": {
    "name": "Crusader",
    "slug": "crusader"
  },
  "createdAt": "2018-10-26T20:19:21+02:00",
  "updatedAt": "2018-10-28T14:26:08+01:00"
}

GET Detail
GET`/v1/stations/{station_slug}/shops/{slug}`

Get Detail of a Shop referenced by its Slug and its Station Slug

URI Parameters

HideShow

station_slug: string (required) Example: port-olisar
The Station Slug
slug: string (required) Example: dumpers-depot
The Shop Slug

Shop Commodities ¶

GET https://api.fleetyards.net/v1/stations/port-olisar/shops/dumpers-depot/shop-commodities

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
    {
        "name": "Avenger Titan",
        "slug": "avenger-titan",
        "storeImage": "http://api.fleetyards.test/uploads/model/store_image/cabcdeec-8af1-4cd9-b403-041f008fedff/Titan_01-Squashed.jpg",
        "category": "model"
        "subCategory": "transport",
        "subCategoryLabel": "Transport",
        "description": "Lacking the prisoner cells of the Stalker or the EMP of the Warlock, the Titan’s hold is free to carry cargo. Couple that with the Avenger’s tried and true combat abilities and you’ve got a light cargo hauler that’s more than capable of handling itself in a fight.\n\n*This is the standard Avenger chassis with the Titan Cargo Module pre-installed.*",
        "sellPrice": "100000.0",
        "buyPrice": null,
        "rentalPrice": null,
        "manufacturer": {
            "name": "Aegis Dynamics",
            "slug": "aegis-dynamics",
            "code": "AEGS",
            "logo": "http://api.fleetyards.test/uploads/manufacturer/logo/cbd6be28-6766-4ed3-935a-86e0828fc0c3/small_Aegis.png"
        },
        "createdAt": "2018-10-27T16:37:32+02:00",
        "updatedAt": "2018-10-28T08:48:59+01:00"
    },
    {
        "name": "Destroyer Mass Driver",
        "slug": "destroyer-mass-driver",
        "storeImage": "http://api.fleetyards.test/assets/fallback/store_image-2105ffa73bd0ba272086daec49ef5d4f6fc8e2a47df7a0c2d07b8d016ad61319.jpg",
        "category": "component",
        "subCategory": "RSIWeapon",
        "subCategoryLabel": "Weapon",
        "description": null,
        "sellPrice": "1000.0",
        "buyPrice": null,
        "rentalPrice": null,
        "manufacturer": {
            "name": "Klaus &amp; Werner",
            "slug": "klaus-amp-werner",
            "code": null,
            "logo": null
        },
        "createdAt": "2018-10-27T12:32:19+02:00",
        "updatedAt": "2018-10-28T02:52:11+02:00"
    },
    ...
]

GET List
GET`/v1/stations/{station_slug}/shops/{slug}/shop-commodities`

Get a List of Shop Commodities

URI Parameters

HideShow

station_slug: string (required) Example: port-olisar
The Station Slug
slug: string (required) Example: dumpers-depot
The Shop Slug

Starsystems ¶

GET https://api.fleetyards.net/v1/starsystems

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
    ...
    {
        "name": "Nyx",
        "slug": "nyx",
        "storeImage": "http://api.fleetyards.test/assets/fallback/store_image-2105ffa73bd0ba272086daec49ef5d4f6fc8e2a47df7a0c2d07b8d016ad61319.jpg",
        "mapX": "42.2",
        "mapY": "22.75",
        "celestialObjects": [
            {
                "name": "Delamar",
                "slug": "delamar",
                "designation": "Delamar",
                "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/720bd053-0cf1-45e5-8c7a-8364596d1a32/delamar.jpg"
            }
        ],
        "createdAt": "2018-10-26T20:19:08+02:00",
        "updatedAt": "2018-10-26T20:24:43+02:00"
    },
    {
        "name": "Stanton",
        "slug": "stanton",
        "storeImage": "http://api.fleetyards.test/uploads/starsystem/store_image/17b3dde9-c594-4667-9fe7-07ce9ba83be0/stanton.jpg",
        "mapX": "59.766411599",
        "mapY": "48.460661345",
        "celestialObjects": [
            {
                "name": "Hurston",
                "slug": "hurston",
                "designation": "Stanton I",
                "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/35908b50-7f8e-4344-85e5-f14d98b2be54/hurston.png"
            },
            {
                "name": "Crusader",
                "slug": "crusader",
                "designation": "Stanton II",
                "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/224e95de-367e-4904-aebc-b85c70d0a318/crusader.jpg"
            }
        ],
        "createdAt": "2018-10-26T20:19:06+02:00",
        "updatedAt": "2018-10-28T14:26:07+01:00"
    }
]

GET List
GET`/v1/starsystems`

Get a List of Starsystems

Starsystem ¶

GET https://api.fleetyards.net/v1/starsystems/stanton

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "name": "Stanton",
  "slug": "stanton",
  "storeImage": "http://api.fleetyards.test/uploads/starsystem/store_image/17b3dde9-c594-4667-9fe7-07ce9ba83be0/stanton.jpg",
  "mapX": "59.766411599",
  "mapY": "48.460661345",
  "celestialObjects": [
    {
      "name": "Hurston",
      "slug": "hurston",
      "designation": "Stanton I",
      "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/35908b50-7f8e-4344-85e5-f14d98b2be54/hurston.png"
    },
    {
      "name": "Crusader",
      "slug": "crusader",
      "designation": "Stanton II",
      "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/224e95de-367e-4904-aebc-b85c70d0a318/crusader.jpg"
    }
  ],
  "createdAt": "2018-10-26T20:19:06+02:00",
  "updatedAt": "2018-10-28T14:26:07+01:00"
}

GET Detail
GET`/v1/starsystems/{slug}`

Get Detail of a Starsystem referenced by its Slug

URI Parameters

HideShow

slug: string (required) Example: stanton
The Starsystem Slug

Celestial Objects ¶

GET https://api.fleetyards.net/v1/celestial-objects

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

[
    ...
    {
        "name": "Hurston",
        "slug": "hurston",
        "designation": "Stanton I",
        "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/35908b50-7f8e-4344-85e5-f14d98b2be54/hurston.png",
        "moons": [],
        "starsystem": {
            "name": "Stanton",
            "slug": "stanton",
            "storeImage": "http://api.fleetyards.test/uploads/starsystem/store_image/17b3dde9-c594-4667-9fe7-07ce9ba83be0/stanton.jpg",
            "mapX": "59.766411599",
            "mapY": "48.460661345"
        },
        "createdAt": "2018-10-26T20:19:07+02:00",
        "updatedAt": "2018-10-28T14:26:09+01:00"
    },
    {
        "name": "Crusader",
        "slug": "crusader",
        "designation": "Stanton II",
        "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/224e95de-367e-4904-aebc-b85c70d0a318/crusader.jpg",
        "moons": [
            {
                "name": "Cellin",
                "slug": "cellin",
                "designation": "Stanton 2a",
                "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/01ec2fc2-6ca3-40e7-a4d7-5a4c78021a10/cellin.jpg"
            },
            {
                "name": "Daymar",
                "slug": "daymar",
                "designation": "Stanton 2b",
                "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/14c78eae-04a5-4455-925d-0f1a5e2933ee/daymar.jpg"
            },
            {
                "name": "Yela",
                "slug": "yela",
                "designation": "Stanton 2c",
                "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/88644597-b695-42cf-9ab5-15a6b61605ca/yela.jpg"
            }
        ],
        "starsystem": {
            "name": "Stanton",
            "slug": "stanton",
            "storeImage": "http://api.fleetyards.test/uploads/starsystem/store_image/17b3dde9-c594-4667-9fe7-07ce9ba83be0/stanton.jpg",
            "mapX": "59.766411599",
            "mapY": "48.460661345"
        },
        "createdAt": "2018-10-26T20:19:07+02:00",
        "updatedAt": "2018-10-28T14:26:07+01:00"
    }
]

GET List
GET`/v1/celestial-objects`

Get a List of Celestial Objects

Celestial Object ¶

GET https://api.fleetyards.net/v1/celestial-objects/crusader

Requestsexample 1

Headers

Content-Type: application/json
Accept: application/json

Responses200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "name": "Crusader",
  "slug": "crusader",
  "designation": "Stanton II",
  "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/224e95de-367e-4904-aebc-b85c70d0a318/crusader.jpg",
  "moons": [
    {
      "name": "Cellin",
      "slug": "cellin",
      "designation": "Stanton 2a",
      "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/01ec2fc2-6ca3-40e7-a4d7-5a4c78021a10/cellin.jpg"
    },
    {
      "name": "Daymar",
      "slug": "daymar",
      "designation": "Stanton 2b",
      "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/14c78eae-04a5-4455-925d-0f1a5e2933ee/daymar.jpg"
    },
    {
      "name": "Yela",
      "slug": "yela",
      "designation": "Stanton 2c",
      "storeImage": "http://api.fleetyards.test/uploads/celestial_object/store_image/88644597-b695-42cf-9ab5-15a6b61605ca/yela.jpg"
    }
  ],
  "starsystem": {
    "name": "Stanton",
    "slug": "stanton",
    "storeImage": "http://api.fleetyards.test/uploads/starsystem/store_image/17b3dde9-c594-4667-9fe7-07ce9ba83be0/stanton.jpg",
    "mapX": "59.766411599",
    "mapY": "48.460661345"
  },
  "createdAt": "2018-10-26T20:19:07+02:00",
  "updatedAt": "2018-10-28T14:26:07+01:00"
}

GET Detail
GET`/v1/celestial-objects/{slug}`

Get Detail of a Celestial Object referenced by its Slug

URI Parameters

HideShow

slug: string (required) Example: crusader
The Celestial Object Slug

Generated by aglio on 30 Dec 2022

API Endpoint

Current Version ¶

Schema ¶

Timestamps

Summary Representations

Detailed Representations

Client Errors ¶

Authentication ¶

Pagination ¶

Link Header

Rate Limiting ¶

Embed Fleetview ¶

Setup ¶

Options ¶

Show Details ¶

Grouped View ¶

Render as Fleetchart ¶

Grouped View for Fleetchart ¶

Initial Fleetchart Scale ¶

Show Fleetchart Slider ¶

Ships List ¶

Users List ¶

Models ¶

Models ¶

Headers

Headers

Body

GET ListGET/v1/models

Models ¶

Headers

Headers

Body

GET ListGET/v1/models/slugs

Models ¶

Headers

Headers

GET LatestGET/v1/models/latest

Filters ¶

Headers

Headers

Body

GET FiltersGET/v1/models/filters

Categories ¶

Model ¶

Headers

Headers

Body

GET DetailGET/v1/models/{slug}

Model ¶

Headers

Headers

Body

GET ImagesGET/v1/models/{slug}/images

Model ¶

Headers

Headers

Body

GET VideosGET/v1/models/{slug}/videos

Model ¶

Headers

Headers

Body

GET ModulesGET/v1/models/{slug}/modules

Model ¶

Headers

Headers

Body

GET VariantsGET/v1/models/{slug}/variants

Components ¶

Components ¶

Headers

Headers

Body

GET Component CategoriesGET/v1/components/categories

Images ¶

Image ¶

Headers

Headers

Body

GET ListGET/v1/images

Current Version

Schema

Client Errors

Authentication

Pagination

Rate Limiting

Setup

Options

Show Details

Grouped View

Render as Fleetchart

Grouped View for Fleetchart

Initial Fleetchart Scale

Show Fleetchart Slider

Ships List

Users List

GET List
GET`/v1/models`

GET List
GET`/v1/models/slugs`

GET Latest
GET`/v1/models/latest`

GET Filters
GET`/v1/models/filters`

Categories

GET Detail
GET`/v1/models/{slug}`

GET Images
GET`/v1/models/{slug}/images`

GET Videos
GET`/v1/models/{slug}/videos`

GET Modules
GET`/v1/models/{slug}/modules`

GET Variants
GET`/v1/models/{slug}/variants`

GET Component Categories
GET`/v1/components/categories`

GET List
GET`/v1/images`

GET Random
GET`/v1/images/random`

POST Create
POST`/v1/sessions`

DELETE Destroy
DELETE`/v1/sessions`

GET Vehicles
GET`/v1/vehicles`

GET Public Vehicles
GET`/v1/vehicles/{username}`

GET List
GET`/v1/stations`

GET Detail
GET`/v1/stations/{slug}`

GET List
GET`/v1/shops`

GET Detail
GET`/v1/stations/{station_slug}/shops/{slug}`

GET List
GET`/v1/stations/{station_slug}/shops/{slug}/shop-commodities`

GET List
GET`/v1/starsystems`

GET Detail
GET`/v1/starsystems/{slug}`