In-Game Item Filters
Returns available filter facet values for in-game items, grouped by field with occurrence counts. Applying other filters narrows the facet results. Use these values as filter[*] parameters on GET /api/items. Scoped to the default item category unless filter[category] is specified.
Query parameters
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.
When false, facets are computed excluding variant items. When true or omitted, all items are included.
Item category to scope facets. Accepts: weapons, weapon-attachments, clothes, armor, food, medical, mining-modifiers, fps-items, vehicle-weapons, vehicle-items, vehicle-flair-items, vehicle-components. Example: weapons
Narrow facets to items matching this type. Example: WeaponPersonal
Narrow facets to items matching this sub-type. Example: Barrel
Narrow facets to items from this manufacturer. Example: KnightBridge Arms
Same as filter[manufacturer]. Example: Anvil Aerospace
Narrow facets to items with matching class name. Example: MGA_Assault
Narrow facets to items with matching name. Example: Arrow
Narrow facets to items matching name or class name. Example: Arrow
Narrow facets to items with matching classification. Example: FPS.Armor.Torso
Narrow facets to items with this size. Example: 3
Narrow facets to items with this grade. Example: 3
Narrow facets to items with this class. Example: Military
Narrow facets to items with this rarity. Example: Rare
Narrow facets to items with this event or reward source. Example: IAE
When set to true, includes items flagged as not player-relevant (test, placeholder, dev items). Default shows only relevant items.
Response
Available filter facets for in-game items, grouped by field with counts.
Changes
Changed in 6 of the 50 revisions of this API.8610
- ▲
the response property
filters/class/items/countbecame nullable for the status200response-property-became-nullable
- ▲
the response property
filters/classification/items/countbecame nullable for the status200response-property-became-nullable
- ▲
the response property
filters/grade/items/countbecame nullable for the status200response-property-became-nullable
- ▲
the response property
filters/manufacturer/items/countbecame nullable for the status200response-property-became-nullable
- ▲
the response property
filters/rarity/items/countbecame nullable for the status200response-property-became-nullable
- ▲
the response property
filters/size/items/countbecame nullable for the status200response-property-became-nullable
- ▲
the response property
filters/sub_type/items/countbecame nullable for the status200response-property-became-nullable
- ▲
the response property
filters/type/items/countbecame nullable for the status200response-property-became-nullable
- ○
added the new optional
queryrequest parameterfilter[event_source]new-optional-request-parameter
- ○
added the optional property
filters/event_sourceto the response with the200statusresponse-optional-property-added
- ▲
- ○
api operation id
8cd032a0b4591c3e203c00e9e5779194removed and replaced withlistItemFiltersapi-operation-id-removed
- ○
api tag
In-Gameremovedapi-tag-removed
- ○
- ○
added the new optional
queryrequest parameterfilter[include_irrelevant]new-optional-request-parameter
- ○
- ○
added the new optional
queryrequest parameterfilter[rarity]new-optional-request-parameter
- ○
added the optional property
filters/rarityto the response with the200statusresponse-optional-property-added
- ○
- ○
added the new optional
queryrequest parameterfilter[query]new-optional-request-parameter
- ○
- ●
deleted the
queryrequest parameterfilter[event_source]request-parameter-removed
- ●
deleted the
queryrequest parameterfilter[include_irrelevant]request-parameter-removed
- ●
deleted the
queryrequest parameterfilter[query]request-parameter-removed
- ●
deleted the
queryrequest parameterfilter[rarity]request-parameter-removed
- ●
removed the optional property
filters/event_sourcefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
filters/rarityfrom the response with the200statusresponse-optional-property-removed
- ○
api operation id
listItemFiltersremoved and replaced with8cd032a0b4591c3e203c00e9e5779194api-operation-id-removed
- ○
api tag
In-Gameaddedapi-tag-added
This revision also has 95 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●