v1

latestOpenAPI 3.0.0MIT (code only)2026-07-1783284693.9 KB
Items

In-Game Item Overview

Returns paginated in-game items for the requested category and game version. Always includes manufacturer, game version, and description data. Crafting blueprints are loaded automatically. Supports filtering by type, classification, manufacturer, size, grade, and more. Available includes: shops, variants, related_items, blueprints, vehicles, shops.items. Supports 150+ JSON field sorts. (see GET /api/items/filters for valid filter values)

get/api/items

Query parameters

pageinteger

Page number for pagination (starts at 1). Prefer using page[number] instead.

page[number]integer

Page number for pagination (starts at 1).

page[size]integer

Number of results per page. Maximum 200.

includestring

Comma-separated list of relationships to include. Available includes vary per endpoint, see each endpoint's description for supported values.

versionstring

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.

sortstring
Example:-weapon.damage.alpha_total

Sort field. Prefix with "-" for descending. Supports 250+ JSON fields. Examples: name, -grade, weapon.damage.alpha_total, -shield_controller.face_type. Use comma for multiple: grade,-name

filter[variants]boolean

When false, excludes variant items (base_id IS NOT NULL) and returns only base items. When true or omitted, returns all items including variants.

filter[category]string

Item category to scope results. Accepts: weapons, weapon-attachments, clothes, armor, food, medical, mining-modifiers, fps-items, vehicle-weapons, vehicle-items, vehicle-flair-items, vehicle-components. Example: weapons

filter[type]string

Exact match on item type. Accepts comma-separated values for OR matching. (see GET /api/items/filters for valid values). Example: WeaponPersonal

filter[sub_type]string

Exact match on item sub-type. Accepts comma-separated values for OR matching. (see GET /api/items/filters for valid values). Example: Barrel

filter[manufacturer]string

Manufacturer name or code. Accepts comma-separated values for OR matching. (see GET /api/items/filters for valid values). Example: KnightBridge Arms

filter[manufacturer.name]string

Same as filter[manufacturer]. Accepts comma-separated values for OR matching. Example: Anvil Aerospace

filter[class_name]string

Partial match on item class name. Example: Controller_Comms

filter[name]string

Partial match on item display name. Example: Arrow

filter[query]string

Search items by name or class name. Example: helmet

filter[classification]string

Partial match on item classification (dot-notation, e.g. FPS.Armor). (see GET /api/items/filters for valid values). Example: FPS.Armor.Torso

filter[size]number

Exact item size (0-12). Example: 3

filter[grade]number

Exact item grade (1-7, mapped to A-G). Example: 3

filter[class]string

Exact match on item class. Accepts comma-separated values for OR matching. (see GET /api/items/filters for valid values). Example: Military

filter[rarity]string

Item rarity. Accepts comma-separated values for OR matching. (see GET /api/items/filters for valid values). Example: Rare

filter[event_source]string

Event or reward source label. Accepts comma-separated values for OR matching. (see GET /api/items/filters for valid values). Example: IAE

filter[include_irrelevant]boolean

When set to true, includes items flagged as not player-relevant (test, placeholder, dev items). Default shows only relevant items.

filter[tags]string

Filter by stdItem.RequiredTags array values. Use when a port has required_tags - matches items whose RequiredTags contain ALL specified values. Accepts comma-separated tags for AND matching. Example: MISC_Fury_Miru

filter[port_tags]string

Filter items by RequiredTags compatibility with a port's tags. Accepts comma-separated port tag values. Returns items where any of their RequiredTags appear in the provided tags, OR items with no RequiredTags but whose Tags overlap with the provided tags (e.g. older paint system). Items with no RequiredTags and no overlapping Tags are excluded. Pass the port_tags value from a vehicle hardpoint port. Example: flight_ready,Ship_Dock_Refuel

filter[vehicle]string

Scope items to a specific vehicle. Accepts one or more vehicle identity tags (from the vehicle's port_tags field). Returns: (1) universal items with no RequiredTags and not bespoke, (2) bespoke items whose RequiredTags match any provided tag, (3) bespoke items whose bespoke_vehicle_tags match any provided tag. Use on vehicle pages to show only items equippable on that vehicle. Example: AEGS_Avenger_Base

Response

List of Items