Free Company

xiv.freecompany

.search(name, params)

https://xivapi.com/docs/Free-Company#search

Search for a Free Company 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/Free-Company#free-company

Get a Free Company from its id.

Params object:

Parameter	Type	Description
extended	boolean	Extend out the 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: { FreeCompany }

---