API:2/stories
From Guild Wars 2 Wiki
< API:2
Jump to navigationJump to search
/v2/stories
- HTTP method
- GET
- Format
- json
- API version
- version 2
- Release date
- 2016-04-29
- Scope
- none
- Optional
- none
This resource returns information about the Story Journal stories; including the personal story and Living World.
Endpoints
- None - Request the list of all available story
idswhen the root endpoint (v2/stories) has been accessed. id- (Optional) Request the story for the specificedidwhen accessing the endpoint (v2/stories/id). Cannot be used when specifying theidoridsparameters.
Parameters
lang– (Optional) Request localized information.page- (Optional; integer)page_size- (Optional; integer)id- (Optional) Request the story for the specifiedid. Cannot be used when specifying theidendpoint oridsparameter.ids- (Optional; Comma Delimited List|all) Request an array of stories for the specifiedidsor all stories. Cannot be used when using theidendpoint oridparameter.
Response
For each requested Story Journal story id, an object with the following properties is returned:
id(integer) - Theidof the story.season(string) - Theidfor the story season; resolvable against v2/stories/seasons.name(string) - The name of the story.description(string) (default/null value: "") - The description of the story.timeline(string) - The (in-game, not real-world) date of the story.level(integer) - The minimum level required for a character to begin this story.order(integer) - The order in which this story is displayed in the Story Journal.chapters(array of object) (default/null value: []) - An array of chapter objects providing details about the chapters for this story. Each object may contain the following values:name(string) - The name of the chapter.
races(array of strings) (Optional) - When present, provides a list of races that are eligible to participate in this story.flags(array of strings) (Optional) - When present, provides a list of additional requirements for a character to participate in this story.
Example
https://api.guildwars2.com/v2/stories
[ 1, 2, 3, 41, 42, 46 ]
https://api.guildwars2.com/v2/stories/1
{
"id":1,
"season":"215AAA0F-CDAC-4F93-86DA-C155A99B5784",
"name":"My Story",
"description":"",
"timeline":"1325 AE",
"level":1,
"races":["Charr"],
"order":0,
"chapters":[
{"name":"1. Getting the Band Back Together"},
{"name":"2. Sins of the Father"},
{"name":"3. Crystal Corruption"}
]
}
https://api.guildwars2.com/v2/stories?ids=41
[
{
"id":41,
"season":"B8901E58-DC9D-4525-ADB2-79C93593291E",
"name":"3. Establishing a Foothold",
"description":"Help the Pact survivors regroup and establish defenses against Mordrem attacks.",
"timeline":"1328 AE",
"level":80,
"order":3003,
"chapters":[]
}
]
https://api.guildwars2.com/v2/stories?id=15
{
"id":15,
"season":"A515A1D3-4BD7-4594-AE30-2C5D05FF5960",
"name":"5. Echoes of the Past",
"description":"As Tyria prepares for war with another Elder Dragon, the search for information becomes paramount...",
"timeline":"1327 AE",
"level":80,
"order":2040,
"chapters":[],
"flags":["RequiresUnlock"]
}
