In-Game Vehicle Detail
Retrieve a vehicle by name, class name, or UUID. Results are scoped to the requested or default game version. Loads manufacturer, gameVersion, shipMatrixVehicle (with foci, productionStatus, productionNote, type, size, loaner, skus, manufacturer, components), and port loadout items.
Path parameters
Vehicle name, class_name, or UUID
Query parameters
Comma-separated list of relationships to include. Available includes vary per endpoint, see each endpoint's description for supported values.
Game version code to scope results to. Omit to use the current default version. Use GET /api/game-versions to list available versions and GET /api/game-versions/default to discover the default.
Response
A Vehicle
Changes
Changed in 26 of the 50 revisions of this API.2750245
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/is_power_suitto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/skus/items/cig_idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/skus/items/discounted_priceto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/skus/items/is_packageto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/skus/items/is_warbondto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/skus/items/sourceto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/skus/items/urlto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/skus/items/cig_idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/skus/items/discounted_priceto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/skus/items/is_packageto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/skus/items/is_warbondto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/skus/items/sourceto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/skus/items/urlto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/description/oneOf[subschema #1: Grouped Translations]/frto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/foci/items/frto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/game_descriptionto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/production_note/oneOf[subschema #1: Grouped Translations]/frto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/production_status/oneOf[subschema #1: Grouped Translations]/frto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/type/oneOf[subschema #1: Grouped Translations]/frto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/description/frto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/foci/items/frto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/production_note/frto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/production_status/frto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/size/frto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #2: Ship Matrix Vehicle]/type/frto the response with the200statusresponse-optional-property-added
- ○
- ▲
added
game_port_item_summaryto thedata/oneOf[subschema #1: Game Vehicle]/ports/items/equipped_itemresponse propertyoneOflist for the response status200response-property-one-of-added
- ▲
- ▲
added
game_port_itemto thedata/oneOf[subschema #1: Game Vehicle]/hardpoints/items/item/oneOf[subschema #1: Vehicle Hardpoint Item v2]/allOf[subschema #1]/ports/items/equipped_itemresponse propertyoneOflist for the response status200response-property-one-of-added
- ●
removed the optional property
data/oneOf[subschema #1: Game Vehicle]/hardpoints/items/item/oneOf[subschema #1: Vehicle Hardpoint Item v2]/allOf[subschema #1]/ports/items/equipped_port_itemfrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/hardpoints/items/item/oneOf[subschema #1: Vehicle Hardpoint Item v2]/allOf[subschema #1]/ports/items/port_tagsto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/hardpoints/items/item/oneOf[subschema #1: Vehicle Hardpoint Item v2]/allOf[subschema #1]/ports/items/portsto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/hardpoints/items/item/oneOf[subschema #1: Vehicle Hardpoint Item v2]/allOf[subschema #1]/ports/items/sub_typeto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/hardpoints/items/item/oneOf[subschema #1: Vehicle Hardpoint Item v2]/allOf[subschema #1]/ports/items/typeto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/no_fuel_paramsto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/ports/items/equipped_item/oneOf[subschema #1: Equipped Port Item]/allOf[subschema #2]/classificationto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/ports/items/equipped_item/oneOf[subschema #1: Equipped Port Item]/allOf[subschema #2]/classification_labelto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/ports/items/equipped_item/oneOf[subschema #1: Equipped Port Item]/allOf[subschema #2]/is_base_variantto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/ports/items/equipped_item/oneOf[subschema #1: Equipped Port Item]/allOf[subschema #2]/variant_nameto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/ports/items/equipped_item/oneOf[subschema #1: Equipped Port Item]/allOf[subschema #2]/web_urlto the response with the200statusresponse-optional-property-added
- ○
removed
item_linkfrom thedata/oneOf[subschema #1: Game Vehicle]/hardpoints/items/item/oneOf[subschema #1: Vehicle Hardpoint Item v2]/allOf[subschema #1]/ports/items/equipped_itemresponse propertyoneOflist for the response status200response-property-one-of-removed
- ▲
- ○
added the optional property
data/oneOf[subschema #1: Game Vehicle]/hardpoints/items/item/oneOf[subschema #1: Vehicle Hardpoint Item v2]/allOf[subschema #1]/ports/items/equipped_item/oneOf[subschema #1: Item Link]/allOf[subschema #2: Metadata]/resourceto the response with the200statusresponse-optional-property-added
- ○
- ▲
the response's body type/format changed from
/toobject/for status200response-body-type-changed
- ○
api operation id
7bbede0623fe40dc123a58b51718a2c8removed and replaced withgetVehicleapi-operation-id-removed
- ○
api tag
In-Gameremovedapi-tag-removed
- ○
removed
game_vehicleship_matrix_vehiclefrom the response bodyoneOflist for the response status200response-body-one-of-removed
- ○
added the non-success response with the status
404response-non-success-status-added
- ○
added the optional property
datato the response with the200statusresponse-optional-property-added
- ▲
- ○
added the optional property
oneOf[subschema #1: Game Vehicle]/shield/regeneration_timeto the response with the200statusresponse-optional-property-added
- ○
- ▲
the response property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/date_updatedbecame nullable for the status200response-property-became-nullable
- ▲
the response property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/price_buybecame nullable for the status200response-property-became-nullable
- ▲
the response property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/terminal_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/terminal_namebecame nullable for the status200response-property-became-nullable
- ▲
the response property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/date_updatedbecame nullable for the status200response-property-became-nullable
- ▲
the response property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/price_rentbecame nullable for the status200response-property-became-nullable
- ▲
the response property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/terminal_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/terminal_namebecame nullable for the status200response-property-became-nullable
- ▲
the
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/date_updatedresponse's property type/format changed fromstring/date-timetostring/for status200response-property-type-changed
- ▲
the
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/price_buyresponse's property type/format changed fromnumber/doubletonumber/for status200response-property-type-changed
- ▲
the
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/date_updatedresponse's property type/format changed fromstring/date-timetostring/for status200response-property-type-changed
- ▲
the
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/price_rentresponse's property type/format changed fromnumber/doubletonumber/for status200response-property-type-changed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/starmap_location_uuidfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/starmap_location_uuidfrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
oneOf[subschema #1: Game Vehicle]/port_tagsto the response with the200statusresponse-optional-property-added
- ○
added the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/price_rentto the response with the200statusresponse-optional-property-added
- ○
added the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/price_sellto the response with the200statusresponse-optional-property-added
- ○
added the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/uex_linkto the response with the200statusresponse-optional-property-added
- ○
added the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/price_buyto the response with the200statusresponse-optional-property-added
- ○
added the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/price_sellto the response with the200statusresponse-optional-property-added
- ○
added the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/uex_linkto the response with the200statusresponse-optional-property-added
- ▲
- ▲
added
starmap_location_linkto theoneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/starmap_locationresponse propertyoneOflist for the response status200response-property-one-of-added
- ▲
added
starmap_location_linkto theoneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/starmap_locationresponse propertyoneOflist for the response status200response-property-one-of-added
- ▲
the
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/starmap_locationresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ▲
the
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/starmap_locationresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/linkfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/starmap_location/namefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/starmap_location/parent_namefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/starmap_location/slugfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/starmap_location/star_system_namefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/starmap_location/type_namefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/purchase/items/web_urlfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/linkfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/starmap_location/namefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/starmap_location/parent_namefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/starmap_location/slugfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/starmap_location/star_system_namefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/starmap_location/type_namefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
oneOf[subschema #1: Game Vehicle]/uex_prices/rental/items/web_urlfrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
oneOf[subschema #1: Game Vehicle]/hardpoints/items/item/oneOf[subschema #1: Vehicle Hardpoint Item v2]/allOf[subschema #1]/ports/items/equipped_item/oneOf[subschema #1: Item Link]/allOf[subschema #1]/web_urlto the response with the200statusresponse-optional-property-added
- ○
added the optional property
oneOf[subschema #1: Game Vehicle]/suit_storageto the response with the200statusresponse-optional-property-added
- ○
added the optional property
oneOf[subschema #1: Game Vehicle]/weapon_storageto the response with the200statusresponse-optional-property-added
- ▲