Free Company
Search and retrieve Free Company data from The Lodestone, provides useful information such as profile information and member lists.
Lodestone Errors
If you receive a HTTP error code response from any of these endpoints, it is very likely from Lodestone itself and not part of XIVAPI. Some common responses are: 404 Not Found / 429 Too Many Requests / 503 Maintenance/freecompany/search #
https://xivapi.com/freecompany/search?name=[name]&server=[server]Params
| Param | Description |
|---|---|
| Name | The name of the free company to search, you can use `+` for spaces or let the API handle it for you. If you search very short names you will get lots of responses. This is an issue with The Lodestone and not much XIVAPI can do about it at this time. |
| Server | *(optional)* The server to search against, this is case sensitive - You can obtain a list of valid servers via: https://xivapi.com/servers |
| Page | *(optional)* Search or move to a specific page. |
/freecompany/[lodestone_id] #
https://xivapi.com/freecompany/9231253336202687179Params
| Param | Description | ||||
|---|---|---|---|---|---|
| extended | If set to 1, the API will return more data in the response by extending out the data IDs to useful objects. | ||||
| data |
By default only the `FreeCompany` data will return, you can request more data using the `data` query. data
https://xivapi.com/freecompany/9231253336202687179?data=FCM
Pass a long a comma separated list of codes that relate to specific data sets you would like to fetch, these are as follows:
|