Skip to content

Character

Kimon Kar edited this page Sep 5, 2019 · 9 revisions
xiv.character

.search(name, params)

https://xivapi.com/docs/Character#search

Search for a character by name.

Params object:

Parameter Type Description
server string The server to search in.
page string The page to navigate to. See Pagination.

Returns: { Pagination, Results: Array }


.get(id, params)

https://xivapi.com/docs/Character#character

Get a character from their id.

Params object:

Parameter Type Description
extended boolean Extend out data IDs to useful objects.
data CSV* Request more data types.
columns CSV* Results will only contain specific data. See more.

*CSV: accepts either string (e.g. 'Entry1,Entry2,Entry3') or array (e.g. ['Entry1', 'Entry2', 'Entry3'])

See params section on the XIVAPI entry for more.

Returns: { Character, Info }

Clone this wiki locally