Items

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.

get/api/items/filters

Query parameters

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.

filter[variants]boolean

When false, facets are computed excluding variant items. When true or omitted, all items are included.

filter[category]string

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

filter[type]string

Narrow facets to items matching this type. Example: WeaponPersonal

filter[sub_type]string

Narrow facets to items matching this sub-type. Example: Barrel

filter[manufacturer]string

Narrow facets to items from this manufacturer. Example: KnightBridge Arms

filter[manufacturer.name]string

Same as filter[manufacturer]. Example: Anvil Aerospace

filter[class_name]string

Narrow facets to items with matching class name. Example: MGA_Assault

filter[name]string

Narrow facets to items with matching name. Example: Arrow

filter[query]string

Narrow facets to items matching name or class name. Example: Arrow

filter[classification]string

Narrow facets to items with matching classification. Example: FPS.Armor.Torso

filter[size]number

Narrow facets to items with this size. Example: 3

filter[grade]number

Narrow facets to items with this grade. Example: 3

filter[class]string

Narrow facets to items with this class. Example: Military

filter[rarity]string

Narrow facets to items with this rarity. Example: Rare

filter[event_source]string

Narrow facets to items with this event or reward source. 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.

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/count became nullable for the status 200

      response-property-became-nullable

    • the response property filters/classification/items/count became nullable for the status 200

      response-property-became-nullable

    • the response property filters/grade/items/count became nullable for the status 200

      response-property-became-nullable

    • the response property filters/manufacturer/items/count became nullable for the status 200

      response-property-became-nullable

    • the response property filters/rarity/items/count became nullable for the status 200

      response-property-became-nullable

    • the response property filters/size/items/count became nullable for the status 200

      response-property-became-nullable

    • the response property filters/sub_type/items/count became nullable for the status 200

      response-property-became-nullable

    • the response property filters/type/items/count became nullable for the status 200

      response-property-became-nullable

    • added the new optional query request parameter filter[event_source]

      new-optional-request-parameter

    • added the optional property filters/event_source to the response with the 200 status

      response-optional-property-added

    • api operation id 8cd032a0b4591c3e203c00e9e5779194 removed and replaced with listItemFilters

      api-operation-id-removed

    • api tag In-Game removed

      api-tag-removed

    • added the new optional query request parameter filter[include_irrelevant]

      new-optional-request-parameter

    • added the new optional query request parameter filter[rarity]

      new-optional-request-parameter

    • added the optional property filters/rarity to the response with the 200 status

      response-optional-property-added

    • added the new optional query request parameter filter[query]

      new-optional-request-parameter

  • 8ff40d443bb462See the full diff
    • deleted the query request parameter filter[event_source]

      request-parameter-removed

    • deleted the query request parameter filter[include_irrelevant]

      request-parameter-removed

    • deleted the query request parameter filter[query]

      request-parameter-removed

    • deleted the query request parameter filter[rarity]

      request-parameter-removed

    • removed the optional property filters/event_source from the response with the 200 status

      response-optional-property-removed

    • removed the optional property filters/rarity from the response with the 200 status

      response-optional-property-removed

    • api operation id listItemFilters removed and replaced with 8cd032a0b4591c3e203c00e9e5779194

      api-operation-id-removed

    • api tag In-Game added

      api-tag-added

    This revision also has 95 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog