In-Game

Vehicles

In-Game Vehicle Search (Deprecated)

Deprecated. Use GET /api/vehicles?filter[name]={value} for name search. This endpoint will be removed in a future version.

post/api/vehicles/search

Query parameters

pageinteger

Page number for pagination (starts at 1).

page[number]integer

Page number for pagination (starts at 1).

page[size]integer

Number of results to return per page.

sortstring

Comma-separated list of fields to sort by. Prefix with - for descending order (e.g. -name,size).

filter[manufacturer]string

filter[manufacturer.name]string

filter[class_name]string

filter[name]string

filter[query]string

Search vehicles by name or class name.

filter[size]integer

filter[size_class]integer

filter[career]string

filter[role]string

filter[is_vehicle]boolean

filter[is_gravlev]boolean

filter[is_spaceship]boolean

filter[mass_total]number

filter[cargo_capacity]number

filter[vehicle_inventory]number

filter[crew.min]integer

filter[health]number

filter[shield.hp]number

filter[shield.face_type]string

filter[speed.scm]number

filter[speed.max]number

filter[armor.health]number

filter[cross_section.length]number

filter[cross_section.width]number

filter[cross_section.height]number

filter[signature.ir_quantum]number

filter[signature.ir_shields]number

filter[signature.em_quantum]number

filter[signature.em_shields]number

Request body

object required

Response

A List of matching Vehicles

uuidstring

Unique vehicle identifier.

namestring

Display name of the vehicle.

game_namestring nullable

Internal game class name.

slugstring

URL-friendly vehicle identifier.

class_namestring

class name.

size_classinteger nullable

Vehicle size classification (1–6).

massnumber nullable

Deprecated, use mass_total instead. Mass is equal to mass_hull.

mass_hullnumber nullable

Hull mass without loadout in kg.

mass_loadoutnumber nullable

Equipped loadout mass in kg.

mass_totalnumber nullable

Total mass (hull + loadout) in kg.

cargo_capacitynumber nullable

Cargo capacity in SCU.

vehicle_inventorynumber nullable

Vehicle stowage in micro SCU

is_vehicleboolean nullable

is_gravlevboolean nullable

is_spaceshipboolean nullable

healthnumber nullable

Total vehicle health pool.

shield_hpnumber nullable

Use shield.hp property instead.

shield_face_typestring nullable

Use shield.face_type property instead.

cross_section_maxnumber nullable

Derived: maximum cross-section dimension (max of x, y, z)

power_poolsobject nullable

Power pool allocation limits by component type. Size of -1 indicates unlimited pool.

careerstring nullable

Primary career classification (see GET /api/vehicles/filters for valid values).

rolestring nullable

Specific role within the career (see GET /api/vehicles/filters for valid values).

web_urlstring nullable

linkstring

idinteger nullable

Ship-Matrix CIG ID

chassis_idinteger nullable

Ship-Matrix chassis ID

shipmatrix_namestring nullable

Ship-Matrix vehicle name

msrpnumber nullable

Ship-Matrix MSRP in USD

pledge_urlstring nullable

Link to RSI pledge store

updated_atstring

Timestamp of last data update.

versionstring

Game version code this data applies to.

In-Game Vehicle Search (Deprecated)

Query parameters

Request body

Response

Changes