API:2/novelties
From Guild Wars 2 Wiki
< API:2
Jump to navigationJump to search
/v2/novelties
- HTTP method
- GET
- Format
- json
- API version
- version 2
- Release date
- 2019-06-11
- Scope
- none
- Optional
- none
This resource returns information about novelties that are available in-game.
Endpoints
- None - Request the list of all available novelty
ids
when the root endpoint (v2/novelties
) has been accessed. id
- (Optional) Request the novelty for the specifiedid
when accessing the endpoint (v2/novelties/id
). Cannot be used when specifying theids
parameter.
Parameters
lang
– (Optional) Request localized information.page
- (Optional; integer)page_size
- (Optional; integer)ids
- (Optional; Comma Delimited List|all) Request an array of novelties for the specifiedids
or all novelties. Cannot be used when accessing theid
endpoint.
Response
For each requested novelty id
, an object with the following properties is returned:
id
(integer) (default/null value: 0) - The id of the novelty.name
(string) (default/null value: "") - The name of the novelty as it appears in-game.description
(string) - The in-game novelty description.icon
(string) (default/null value: "") - Theicon
url for the novelty.slot
(string) (default/null value: "") - The slot which the novelty appears in the UI for.- Possible responses:
Chair
,Music
,HeldItem
,Miscellaneous
(for Toys), orTonic
- Possible responses:
unlock_item
(array of numbers) (optional) - An array of itemids
used to unlock the novelty. Can be resolved against v2/items
Example
https://api.guildwars2.com/v2/novelties/1
{ "id": 1, "name": "Embellished Kite", "description": "<c=@abilitytype>Held Item.</c> Equip a bundle for decoration or to use noncombat skills.", "icon": "https://render.guildwars2.com/file/7B043D640ED57517051D5FC038D7CDDDE5F82933/2015154.png", "slot": "HeldItem", "unlock_item": [ 88124 ] }