v1

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

In-Game Item Search (Deprecated)

Deprecated. Use GET /api/items?filter[name]={value} for name search. Note: OR search across name/uuid/type is no longer supported. This endpoint will be removed in a future version.

post/api/items/search

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.

localestring

Locale code for translated fields. Supported values depend on available translations (e.g. en, de, zh).

includestring

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

sortstring

Comma-separated sort fields. Prefix with - for descending. Supported fields vary per endpoint.

filter[variants]boolean

When false, excludes variant items and returns only base items. When true or omitted, returns all items.

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: MGA_Assault

filter[name]string

Partial match on item display name. Example: Arrow

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[include_irrelevant]boolean

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

Request body

object required

Response

A List of matching Items