Search

XIVAPI provides the ability to quickly search all game content via Elasticsearch. This search endpoint only searches game content and not: characters, free companies, linkshells or pvp teams. Those have their own dedicated search endpoints as they relay to Lodestone.

A string or filter is required to search.

Search for something! The search is multi-content and contains combined data, this means your search request covers a vast amount of selected content (which you can further extend via filters) and results are combined based on best-case matching.

Params

Deprecation Notice:

Search filters are now in maintenance mode. We won't be adding any additional filter abilities. If you want uncapped power for search, please considering using Elasticsearch queries, view the advanced section for more information. Note that the majority of users will not need this, and no support or additional docs are offered.

The column to use in string searches.

Filters

Filters can be performed in the following format:

[FieldName][Operator][Value], eg: LevelItem>=150

You can provide a comma separated list of filters as an "AND" exclusive query, eg:

eg: https://xivapi.com/search?filters=LevelItem>35,LevelItem<=40,ClassJobCategory.ID=38

Accepted Operators:

Search for lore! This is a special built search endpoint which searches a string through various lore specific content. The endpoint has all the same features as the /search endpoint including Advanced Elasticsearch Queries.

The "Data" column provides more information about the source of the lore entry such as the content name and icon. You can access this using the "columns" query parameter, for example:

eg: https://xivapi.com/lore?string=legendary&columns=Text,Data

The current content included in lore are:

• Cutscene Subtitles
• All Quest Dialogue and text data
• Item Descriptions
• Leve text data
• FATE text data
• NPC Yells
• NPC Balloon tooltips
• Instance Content and Public content text data
• Achievement Descriptions
• Default Talk entries
• Event Item Help text
• Mounts and Minion text
• Status descriptions
• Triple Triad Card text

If you want more, just hop on discord!

Advanced Elasticsearch Queries

As search just uses the powerful Elasticsearch, you can infact just provide an Elasticsearch valid JSON query to the endpoint as the "body" param and it will be processed. This bypasses all of the normal GET attributes you see above (excluding: indexes) and allows you complete control over how you build the Elastic query. Be aware that we run ES 6.8, and so any reference documentation you search for should reflect that as ES changes query syntax across versions.

You can learn more about Elasticsearch queries via the Query DSL Documentation

How do I get this awesome power!?

By simply sending a JSON payload with the Elasticsearch query in the "body" field, search will switch to advanced mode whenever it sees a query in the "body" field. You can test your DSL using the Search Playground.

The payload is in the following format:

{
    "body": {
        // The Elastic Search payload
    },
    "indexes": "comma,list,of,indexes",
}

Here is a full working example:

{
  "indexes": "item,achievement,instantcontent",
  "body": {
    "query": {
      "bool": {
        "must": [
          {
            "wildcard": {
              "NameCombined_en": "*aiming*"
            }
          }
        ],
        "filter": [
          {
            "range": {
              "ItemSearchCategory.ID": {
                "gt": "1"
              }
            }
          },
          {
            "range": {
              "LevelItem": {
                "gte": "100"
              }
            }
          },
          {
            "range": {
              "LevelItem": {
                "lte": "125"
              }
            }
          }
        ]
      }
    },
    "from": 0,
    "size": 10,
    "sort": [
      {
        "LevelItem": "desc"
      }
    ]
  }
}