esi

v0.1.1

esi v0.1.1 ESI.API.Search

Summary

Types

search_opt()
search_opts()

Options for Search.search/1

Functions

search(opts \\ [])

Search for entities that match a given sub-string

Types

search_opt() 
search_opt ::
  {:categories, [:agent | :alliance | :character | :constellation | :corporation | :faction | :inventorytype | :region | :solarsystem | :station | :wormhole]} |
  {:language, nil | :de | :"en-us" | :fr | :ja | :ru | :zh} |
  {:search, String.t} |
  {:strict, nil | boolean}
search_opts() 
search_opts() :: [search_opt]

Options for Search.search/1.

  • :categories (REQUIRED) — Type of entities to search for
  • :language (DEFAULT: :"en-us") — Language to use in the response
  • :search (REQUIRED) — The string to search on
  • :strict (DEFAULT: false) — Whether the search should be a strict match

Functions

search(opts \\ []) 
search(opts :: search_opts) :: ESI.Request.t

Search for entities that match a given sub-string..

Response Example

A list of search results:

%{"solarsystem" => [30002510],
  "station" => [60004588, 60004594, 60005725, 60009106, 60012721, 60012724,
   60012727]}

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_search
  • path — /search/

View on ESI Site