REST API Documentation

API Documentation

• Characters
  • /api/v1/characters
  • /api/v1/characters/count

To be continued

##Characters ###api/v1/characters Return an array of characters
####Query filters

Name	Parameters Structure	Description	Values
lfg	[value]	filter characters looking or not for a guild	true: character who are looking for a guild false: characters who are not looking for a guild
faction	[value]	filter by faction	0:Alliance 1:Horde
language	[value]	filter by language	language ISO_639-1 code
raids_per_week	[min].[max]	filter by raids per week	[role]: minimum number raids per week [class_id]: maximum number raids per week
day*	[day].[startHour].[endHour].[timezone]	filter by day and hour with timezone	[day]: monday, tuesday, wednesday, thursday, friday, saturday, sunday [startHour]: 0-23 [endHour]: 0-23 [timezone]: any timezone supported by moment.js (ex: 'America/Los_Angeles')
progress	[difficulty].[minKill].[maxKill]	filter by max progress	[difficulty]: normal, heroic, mythic [minKill]: minimum kill number [maxKill]: maximum kill number
role*	[value]	filter by role	tank, heal, melee_dps, ranged_dps
class*	[value]	filter by class	Blizzard class Id
ilevel	[min].[max]	filter by ilevel	[min]: Minimum ilevel [max]: Maximum ilevel
transfert	[value]	filter only character OK with transfert	true: only show characters who accept transfert false: only show characters who don't accept transfert
level_max	[value]	show only level max characters	true: only show level max characters false: show all characters
last	[id].[value]	return characters after this one	[id]: id of the last previous item [value]: value of the last preview item (progress,ranking,updated)
realm*	[region].[name]	filter by realm	[region]: The realm region (eu, us, kr, tw) [name]: The realm name in locale en_GB
realm_zone*	[region].[locale].[timezone]	filter by realm zone	us.en_US.America/Chicago us.en_US.America/Los_Angeles us.en_US.America/New_York us.en_US.America/Denver us.en_US.Australia/Melbourne us.es_MX.America/Chicago us.pt_BR.America/Sao_Paulo eu.en_GB.Europe/Paris eu.de_DE.Europe/Paris eu.fr_FR.Europe/Paris eu.es_ES.Europe/Paris eu.ru_RU.Europe/Paris eu.pt_BR.Europe/Paris tw.zh_TW.Asia/Taipei kr.ko_KR.Asia/Seoul
*Can be send multiple time to make an array.

####Query view

Name	Value
view	minimal: return only minimal informations detailed: return more informations

####Query limit

Name	Value
number	The number of items to retrieve (min 0 & max 10)

####Query sort

Name	Value
sort	progress: sort by progress ilevel: sort by ilevel date: sort by date

###api/v1/characters/count Return the number of characters ####Query filters

Name	Parameters Structure	Description	Values
lfg	[value]	filter characters looking or not for a guild	true: character who are looking for a guild false: characters who are not looking for a guild
faction	[value]	filter by faction	0:Alliance 1:Horde
language	[value]	filter by language	language ISO_639-1 code
raids_per_week	[min].[max]	filter by raids per week	[role]: minimum number raids per week [class_id]: maximum number raids per week
day*	[day].[startHour].[endHour].[timezone]	filter by day and hour with timezone	[day]: monday, tuesday, wednesday, thursday, friday, saturday, sunday [startHour]: 0-23 [endHour]: 0-23 [timezone]: any timezone supported by moment.js (ex: 'America/Los_Angeles')
progress	[difficulty].[minKill].[maxKill]	filter by max progress	[difficulty]: normal, heroic, mythic [minKill]: minimum kill number [maxKill]: maximum kill number
role*	[value]	filter by role	tank, heal, melee_dps, ranged_dps
class*	[value]	filter by class	Blizzard class Id
ilevel	[min].[max]	filter by ilevel	[min]: Minimum ilevel [max]: Maximum ilevel
transfert	[value]	filter only character OK with transfert	true: only show characters who accept transfert false: only show characters who don't accept transfert
level_max	[value]	show only level max characters	true: only show level max characters false: show all characters
last	[id].[value]	return characters after this one	[id]: id of the last previous item [value]: value of the last preview item (progress,ranking,updated)
realm*	[region].[name]	filter by realm	[region]: The realm region (eu, us, kr, tw) [name]: The realm name in locale en_GB
realm_zone*	[region].[locale].[timezone]	filter by realm zone	us.en_US.America/Chicago us.en_US.America/Los_Angeles us.en_US.America/New_York us.en_US.America/Denver us.en_US.Australia/Melbourne us.es_MX.America/Chicago us.pt_BR.America/Sao_Paulo eu.en_GB.Europe/Paris eu.de_DE.Europe/Paris eu.fr_FR.Europe/Paris eu.es_ES.Europe/Paris eu.ru_RU.Europe/Paris eu.pt_BR.Europe/Paris tw.zh_TW.Asia/Taipei kr.ko_KR.Asia/Seoul
*Can be send multiple time to make an array.