API/Collections
< API
ps2
The default recommended namespace. Will be pointed to newer versions as they become available. ps2:v2 is the current default namespace. ps2:v1 is old but may still be called with ...get/ps2:v1/. ps2-beta is now retired.
v2
v2 Developer Email [1]
single_character_by_id
single_character_by_id | |
---|---|
Type | |
Resolve List | online_status,friends,world,outfit,item,profile,faction |
Description | {{{description}}} |
Structure | API/Collections/single_character_by_id |
Parameters | NO VALID FIELDS LIST RETURNED |
Example | {{{example}}} |
character
character | |
---|---|
Type | |
Resolve List | item,item_full,profile,faction,stat,stat_by_faction,weapon_stat,weapon_stat_by_faction,stat_history,online_status,friends,world,outfit,outfit_member,outfit_member_extended,currency |
Description | {{{description}}} |
Structure | API/Collections/character |
Parameters | battle_rank,battle_rank.percent_to_next,battle_rank.value,certs,certs.available_points,certs.earned_points,certs.gifted_points,certs.percent_to_next,certs.spent_points,character_id,daily_ribbon,daily_ribbon.count,daily_ribbon.date,daily_ribbon.time,faction_id,head_id,name,name.first,name.first_lower,profile_id,times,times.creation,times.creation_date,times.last_login,times.last_login_date,times.last_save,times.last_save_date,times.login_count,times.minutes_played,title_id |
Example | {{{example}}} |
character_name
character_name | |
---|---|
Type | |
Resolve List | item,vehicle |
Description | {{{description}}} |
Structure | API/Collections/character_name |
Parameters | character_id,name,name.first,name.first_lower |
Example | {{{example}}} |
characters_achievement
characters_achievement | |
---|---|
Type | |
Resolve List | item,vehicle |
Description | {{{description}}} |
Structure | API/Collections/characters_achievement |
Parameters | achievement_id,character_id,earned_count,finish,finish_date,last_save,last_save_date,start,start_date |
Example | {{{example}}} |
characters_currency
characters_currency | |
---|---|
Type | |
Resolve List | item |
Description | {{{description}}} |
Structure | API/Collections/characters_currency |
Parameters | aerospace,character_id,infantry,mechanized |
Example | {{{example}}} |
characters_skill
characters_skill | |
---|---|
Type | |
Resolve List | leader,leader_name,leaders_stat_history,member,rank,member_character,member_character_name,member_characters_stat_history,member_online_status |
Description | {{{description}}} |
Structure | API/Collections/characters_skill |
Parameters | character_id,last_save,last_save_date,skill_id |
Example | {{{example}}} |
characters_stat
characters_stat | |
---|---|
Type | |
Resolve List | character,character_name,characters_stat_history,online_status,outfit |
Description | {{{description}}} |
Structure | API/Collections/characters_stat |
Parameters | character_id,last_save,last_save_date,profile_id,stat_name,value_daily,value_forever,value_monthly,value_one_life_max,value_weekly |
Example | {{{example}}} |
characters_stat_by_faction
characters_stat_by_faction | |
---|---|
Type | |
Resolve List | character,character_name,world |
Description | {{{description}}} |
Structure | API/Collections/characters_stat_by_faction |
Parameters | character_id,last_save,last_save_date,profile_id,stat_name,value_daily_nc,value_daily_tr,value_daily_vs,value_forever_nc,value_forever_tr,value_forever_vs,value_monthly_nc,value_monthly_tr,value_monthly_vs,value_one_life_max_nc,value_one_life_max_tr,value_one_life_max_vs,value_weekly_nc,value_weekly_tr,value_weekly_vs |
Example | {{{example}}} |
characters_stat_history
characters_stat_history | |
---|---|
Type | |
Resolve List | character,world,character_name,characters_stat_history |
Description | {{{description}}} |
Structure | API/Collections/characters_stat_history |
Parameters | all_time,character_id,day,day.d01,day.d02,day.d03,day.d04,day.d05,day.d06,day.d07,day.d08,day.d09,day.d10,day.d11,day.d12,day.d13,day.d14,day.d15,day.d16,day.d17,day.d18,day.d19,day.d20,day.d21,day.d22,day.d23,day.d24,day.d25,day.d26,day.d27,day.d28,day.d29,day.d30,day.d31,last_save,last_save_date,month,month.m01,month.m02,month.m03,month.m04,month.m05,month.m06,month.m07,month.m08,month.m09,month.m10,month.m11,month.m12,one_life_max,stat_name,week,week.w01,week.w02,week.w03,week.w04,week.w05,week.w06,week.w07,week.w08,week.w09,week.w10,week.w11,week.w12,week.w13 |
Example | {{{example}}} |
characters_weapon_stat
characters_weapon_stat | |
---|---|
Type | |
Resolve List | character,character_name,characters_stat_history,world |
Description | {{{description}}} |
Structure | API/Collections/characters_weapon_stat |
Parameters | character_id,item_id,last_save,last_save_date,stat_name,value,vehicle_id |
Example | {{{example}}} |
characters_weapon_stat_by_faction
characters_weapon_stat_by_faction | |
---|---|
Type | |
Resolve List | character,character_name,characters_stat_history |
Description | {{{description}}} |
Structure | API/Collections/characters_weapon_stat_by_faction |
Parameters | character_id,item_id,last_save,last_save_date,stat_name,value_nc,value_tr,value_vs,vehicle_id |
Example | {{{example}}} |
world_stat_history
world_stat_history | |
---|---|
Type | |
Resolve List | character,character_name,characters_stat_history,attacker,attacker_name,attackers_stat_history |
Description | {{{description}}} |
Structure | API/Collections/world_stat_history |
Parameters | all_time,day,day.d01,day.d02,day.d03,day.d04,day.d05,day.d06,day.d07,day.d08,day.d09,day.d10,day.d11,day.d12,day.d13,day.d14,day.d15,day.d16,day.d17,day.d18,day.d19,day.d20,day.d21,day.d22,day.d23,day.d24,day.d25,day.d26,day.d27,day.d28,day.d29,day.d30,day.d31,faction,last_save,last_save_date,month,month.m01,month.m02,month.m03,month.m04,month.m05,month.m06,month.m07,month.m08,month.m09,month.m10,month.m11,month.m12,stat_name,tracker_name,type,week,week.w01,week.w02,week.w03,week.w04,week.w05,week.w06,week.w07,week.w08,week.w09,week.w10,week.w11,week.w12,week.w13,world_id |
Example | {{{example}}} |
characters_item
characters_item | |
---|---|
Type | |
Resolve List | character,character_name,characters_stat_history,attacker,attacker_name,attackers_stat_history |
Description | {{{description}}} |
Structure | API/Collections/characters_item |
Parameters | NO VALID FIELDS LIST RETURNED |
Example | {{{example}}} |
achievement
achievement | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/achievement |
Parameters | achievement_id,description,description.de,description.en,description.es,description.fr,description.it,description.tr,image_id,image_path,image_set_id,item_id,name,name.de,name.en,name.es,name.fr,name.it,name.tr,repeatable |
Example | {{{example}}} |
currency
currency | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/currency |
Parameters | currency_id,icon_id,inventory_cap,name,name.de,name.en,name.es,name.fr,name.it,name.tr |
Example | {{{example}}} |
experience_rank
experience_rank | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/experience_rank |
Parameters | nc,nc.image_id,nc.image_set_id,nc.title,nc.title.de,nc.title.en,nc.title.es,nc.title.fr,nc.title.it,nc.title.tr,nc_image_path,rank,tr,tr.image_id,tr.image_set_id,tr.title,tr.title.de,tr.title.en,tr.title.es,tr.title.fr,tr.title.it,tr.title.tr,tr_image_path,vs,vs.image_id,vs.image_set_id,vs.title,vs.title.de,vs.title.en,vs.title.es,vs.title.fr,vs.title.it,vs.title.tr,vs_image_path,xp_max |
Example | {{{example}}} |
facility_link
facility_link | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/facility_link |
Parameters | description,facility_id_a,facility_id_b,zone_id |
Example | {{{example}}} |
facility_type
facility_type | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/facility_type |
Parameters | description,facility_type_id |
Example | {{{example}}} |
faction
faction | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/faction |
Parameters | code_tag,faction_id,image_id,image_path,image_set_id,name,name.de,name.en,name.es,name.fr,name.it,name.tr,user_selectable |
Example | {{{example}}} |
fire_mode
fire_mode | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/fire_mode |
Parameters | cof_recoil,damage,damage_max,damage_max_range,damage_min,damage_min_range,damage_radius,damage_resist_type,damage_target_type,damage_type,default_zoom,description,description.de,description.en,description.es,description.fr,description.it,description.tr,indirect_damage_max,indirect_damage_max_range,indirect_damage_min,indirect_damage_min_range,indirect_damage_resist_type,indirect_damage_target_type,item_id,max_speed,muzzle_velocity,pellet_spread,pellets_per_shot,player_state_group_id,projectile_description,reload_chamber_time_ms,reload_time_ms,speed,type |
Example | {{{example}}} |
image
image | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/image |
Parameters | description,image_id,path |
Example | {{{example}}} |
image_set
image_set | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/image_set |
Parameters | description,image_id,image_path,image_set_id,type_description,type_id |
Example | {{{example}}} |
image_set_default
image_set_default | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/image_set_default |
Parameters | description,image_id,image_path,image_set_id,type_description,type_id |
Example | {{{example}}} |
item
item | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/item |
Parameters | description,description.de,description.en,description.es,description.fr,description.it,description.tr,faction_id,image_id,image_path,image_set_id,is_default_attachment,is_vehicle_weapon,item_category_id,item_id,item_type_id,max_stack_size,name,name.de,name.en,name.es,name.fr,name.it,name.tr,release_time,skill_set_id |
Example | {{{example}}} |
item_attachment
item_attachment | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/item_attachment |
Parameters | attachment_item_id,item_id |
Example | {{{example}}} |
item_category
item_category | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/item_category |
Parameters | item_category_id,name,name.de,name.en,name.es,name.fr,name.it,name.tr |
Example | {{{example}}} |
item_profile
item_profile | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/item_profile |
Parameters | item_id,profile_id |
Example | {{{example}}} |
item_type
item_type | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/item_type |
Parameters | code,item_type_id,name |
Example | {{{example}}} |
map_hex
map_hex | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/map_hex |
Parameters | hex_type,map_region_id,type_name,x,y,zone_id |
Example | {{{example}}} |
map_region
map_region | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/map_region |
Parameters | facility_id,facility_name,facility_type,facility_type_id,location_x,location_y,location_z,map_region_id,reward_amount,reward_currency_id,zone_id |
Example | {{{example}}} |
marketing_bundle
marketing_bundle | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/marketing_bundle |
Parameters | cert_price,description,description.de,description.en,description.es,description.fr,description.it,description.tr,image_id,marketing_bundle_id,name,name.de,name.en,name.es,name.fr,name.it,name.tr,release_time,station_cash_price |
Example | {{{example}}} |
marketing_bundle_item
marketing_bundle_item | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/marketing_bundle_item |
Parameters | item_id,marketing_bundle_id,quantity,release_time |
Example | {{{example}}} |
player_state_group
player_state_group | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/player_state_group |
Parameters | min_cone_of_fire,player_state,player_state_group_id |
Example | {{{example}}} |
profile
profile | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/profile |
Parameters | backpedal_speed_modifier,description,description.de,description.en,description.es,description.fr,description.it,description.tr,faction_id,image_id,image_path,image_set_id,movement_speed,name,name.de,name.en,name.es,name.fr,name.it,name.tr,profile_id,profile_type_description,profile_type_id,sprint_speed_modifier,strafe_speed_modifier |
Example | {{{example}}} |
region
region | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/region |
Parameters | initial_faction_id,name,name.de,name.en,name.es,name.fr,name.it,name.tr,region_id,zone_id |
Example | {{{example}}} |
skill
skill | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/skill |
Parameters | description,description.de,description.en,description.es,description.fr,description.it,description.tr,grant_item_id,image_id,image_path,image_set_id,name,name.de,name.en,name.es,name.fr,name.it,name.tr,skill_id,skill_line_id,skill_line_index,skill_points |
Example | {{{example}}} |
skill_category
skill_category | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/skill_category |
Parameters | description,description.de,description.en,description.es,description.fr,description.it,description.tr,image_id,image_path,image_set_id,name,name.de,name.en,name.es,name.fr,name.it,name.tr,skill_category_id,skill_points,skill_set_id,skill_set_index |
Example | {{{example}}} |
skill_line
skill_line | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/skill_line |
Parameters | description,description.de,description.en,description.es,description.fr,description.it,description.tr,image_id,image_path,image_set_id,name,name.de,name.en,name.es,name.fr,name.it,name.tr,required_skill_set_id,skill_category_id,skill_category_index,skill_line_id,skill_points,skill_set_id,skill_set_index |
Example | {{{example}}} |
skill_set
skill_set | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/skill_set |
Parameters | description,description.de,description.en,description.es,description.fr,description.it,description.tr,image_id,image_path,image_set_id,name,name.de,name.en,name.es,name.fr,name.it,name.tr,required_item_id,skill_points,skill_set_id |
Example | {{{example}}} |
vehicle
vehicle | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/vehicle |
Parameters | cost,cost_resource_id,description,description.de,description.en,description.es,description.fr,description.it,description.tr,image_id,image_path,image_set_id,name,name.de,name.en,name.es,name.fr,name.it,name.tr,type_id,type_name,vehicle_id |
Example | {{{example}}} |
vehicle_attachment
vehicle_attachment | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/vehicle_attachment |
Parameters | description,faction_id,item_id,slot_id,vehicle_id |
Example | {{{example}}} |
vehicle_faction
vehicle_faction | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/vehicle_faction |
Parameters | faction_id,vehicle_id |
Example | {{{example}}} |
vehicle_skill_set
vehicle_skill_set | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/vehicle_skill_set |
Parameters | display_index,faction_id,skill_set_id,vehicle_id |
Example | {{{example}}} |
weapon_datasheet
weapon_datasheet | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/weapon_datasheet |
Parameters | capacity,clip_size,damage,damage_max,damage_min,direct_damage,fire_cone,fire_cone_max,fire_cone_min,fire_rate_ms,fire_rate_ms_min,fire_rate_mx_max,indirect_damage,item_id,range,range.de,range.en,range.es,range.fr,range.it,range.tr,reload_ms,reload_ms_max,reload_ms_min,show_clip_size,show_fire_modes,show_range |
Example | {{{example}}} |
zone
zone | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/zone |
Parameters | code,description,description.de,description.en,description.es,description.fr,description.it,description.tr,hex_size,name,name.de,name.en,name.es,name.fr,name.it,name.tr,zone_id |
Example | {{{example}}} |
characters_world
characters_world | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/characters_world |
Parameters | character_id,world_id |
Example | {{{example}}} |
world
world | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/world |
Parameters | description_t4id,name_t4id,state,world_id |
Example | {{{example}}} |
outfit
outfit | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/outfit |
Parameters | alias,alias_lower,leader_character_id,member_count,name,name_lower,outfit_id,time_created,time_created_date |
Example | {{{example}}} |
outfit_member
outfit_member | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/outfit_member |
Parameters | character_id,member_since,member_since_date,outfit_id,rank,rank_ordinal |
Example | {{{example}}} |
outfit_member_extended
outfit_member_extended | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/outfit_member_extended |
Parameters | alias,alias_lower,character_id,leader_character_id,member_count,member_rank,member_rank_ordinal,member_since,member_since_date,name,name_lower,outfit_id,time_created,time_created_date |
Example | {{{example}}} |
outfit_rank
outfit_rank | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/outfit_rank |
Parameters | description,name,ordinal,outfit_id |
Example | {{{example}}} |
characters_online_status
characters_online_status | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/characters_online_status |
Parameters | NO VALID FIELDS LIST RETURNED |
Example | {{{example}}} |
map
map | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/map |
Parameters | NO VALID FIELDS LIST RETURNED |
Example | {{{example}}} |
characters_friend
characters_friend | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/characters_friend |
Parameters | NO VALID FIELDS LIST RETURNED |
Example | {{{example}}} |
characters_world
characters_world | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/characters_world |
Parameters | character_id,world_id |
Example | {{{example}}} |
leaderboard
leaderboard | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/leaderboard |
Parameters | NO VALID FIELDS LIST RETURNED |
Example | {{{example}}} |
characters_leaderboard
characters_leaderboard | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/characters_leaderboard |
Parameters | NO VALID FIELDS LIST RETURNED |
Example | {{{example}}} |
characters_event_grouped
characters_event_grouped | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/characters_event_grouped |
Parameters | character_id,id,type |
Example | {{{example}}} |
characters_event
characters_event | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/characters_event |
Parameters | after,before,character_id,id,type |
Example | {{{example}}} |
event
event | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/event |
Parameters | after,before,type |
Example | {{{example}}} |
world_event
world_event | |
---|---|
Type | |
Resolve List | NO RESOLVES |
Description | {{{description}}} |
Structure | API/Collections/world_event |
Parameters | after,before,id,type,world_id |
Example | {{{example}}} |
v1
single_character_by_id
single_character_by_id | |
---|---|
Type | |
Resolve List | online_status, friends, world, outfit, item, active_profile, faction |
Description | |
Structure | API/Collections/single_character_by_id |
Parameters | |
Example |
character
character | |
---|---|
Type | |
Resolve List | item, item_full, active_profile, faction, stat, stat_by_faction, weapon_stat, weapon_stat_by_faction, stat_history, online_status, friends, world, outfit, outfit_member, outfit_member_extended, currency |
Description | |
Structure | API/Collections/character |
Parameters | |
Example |
character_name
character_name | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/character_name |
Parameters | |
Example |
characters_achievement
characters_achievement | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/characters_achievement |
Parameters | |
Example |
characters_currency
characters_currency | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/characters_currency |
Parameters | |
Example |
characters_skill
characters_skill | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/characters_skill |
Parameters | |
Example |
characters_stat
characters_stat | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/characters_stat |
Parameters | |
Example |
characters_stat_by_faction
characters_stat_by_faction | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/characters_stat_by_faction |
Parameters | |
Example |
characters_stat_history
characters_stat_history | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/characters_stat_history |
Parameters | |
Example |
characters_weapon_stat
characters_weapon_stat | |
---|---|
Type | |
Resolve List | item, vehicle |
Description | |
Structure | API/Collections/characters_weapon_stat |
Parameters | |
Example |
characters_weapon_stat_by_faction
characters_weapon_stat_by_faction | |
---|---|
Type | |
Resolve List | item, vehicle |
Description | |
Structure | API/Collections/characters_weapon_stat_by_faction |
Parameters | |
Example |
characters_item
characters_item | |
---|---|
Type | |
Resolve List | item |
Description | |
Structure | API/Collections/characters_item |
Parameters | |
Example |
characters_world
characters_world | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/characters_world |
Parameters | |
Example |
world
world | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/world |
Parameters | |
Example |
outfit
outfit | |
---|---|
Type | |
Resolve List | leader, leader_name, leaders_stat_history, member, rank, member_character, member_character_name, member_characters_stat_history, member_online_status |
Description | |
Structure | API/Collections/outfit |
Parameters | |
Example |
outfit_member
outfit_member | |
---|---|
Type | |
Resolve List | character, character_name, characters_stat_history, online_status, outfit |
Description | |
Structure | API/Collections/outfit_member |
Parameters | |
Example |
outfit_member_extended
outfit_member_extended | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/outfit_member_extended |
Parameters | |
Example |
outfit_rank
outfit_rank | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/outfit_rank |
Parameters | |
Example |
characters_online_status
characters_online_status | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/characters_online_status |
Parameters | |
Example |
map
map | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/map |
Parameters | |
Example |
characters_friend
characters_friend | |
---|---|
Type | |
Resolve List | character, character_name, world |
Description | |
Structure | API/Collections/characters_friend |
Parameters | |
Example |
characters_world
characters_world | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/characters_world |
Parameters | |
Example |
leaderboard
leaderboard | |
---|---|
Type | |
Resolve List | character, world, character_name, characters_stat_history |
Description | |
Structure | API/Collections/leaderboard |
Parameters | |
Example |
characters_leaderboard
characters_leaderboard | |
---|---|
Type | |
Resolve List | character, character_name, characters_stat_history, world |
Description | |
Structure | API/Collections/characters_leaderboard |
Parameters | |
Example |
characters_event_grouped
characters_event_grouped | |
---|---|
Type | |
Resolve List | character, character_name, characters_stat_history |
Description | |
Structure | API/Collections/characters_event_grouped |
Parameters | |
Example |
characters_event
characters_event | |
---|---|
Type | |
Resolve List | character, character_name, characters_stat_history, attacker, attacker_name, attackers_stat_history |
Description | |
Structure | API/Collections/characters_event |
Parameters | |
Example |
event
event | |
---|---|
Type | |
Resolve List | character, character_name, characters_stat_history, attacker, attacker_name, attackers_stat_history |
Description | |
Structure | API/Collections/event |
Parameters | |
Example |
world_event
world_event | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/world_event |
Parameters | |
Example |
amerishmap
amerishmap | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/amerishmap |
Parameters | |
Example |
currency
currency | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/currency |
Parameters | |
Example |
esamirmap
esamirmap | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/esamirmap |
Parameters | |
Example |
faction
faction | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/faction |
Parameters | |
Example |
icon.attachment
icon.attachment | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/icon.attachment |
Parameters | |
Example |
indarmap
indarmap | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/indarmap |
Parameters | |
Example |
item
item | |
---|---|
Type | |
Resolve List | attachment |
Description | |
Structure | API/Collections/item |
Parameters | |
Example |
profile
profile | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/profile |
Parameters | |
Example |
profile.type
profile.type | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/profile.type |
Parameters | |
Example |
rank
rank | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/rank |
Parameters | |
Example |
resource
resource | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/resource |
Parameters | |
Example |
stat_info
stat_info | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/stat_info |
Parameters | |
Example |
vehicle
vehicle | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/vehicle |
Parameters | |
Example |
zone
zone | |
---|---|
Type | |
Resolve List | |
Description | |
Structure | API/Collections/zone |
Parameters | |
Example |
ps2-beta
This is the original publicly available namespace. It is deprecated and not recommended for use.
amerishmap
amerishmap | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all territories on Amerish. |
Structure | API/Collections/amerishmap |
Parameters | |
Example |
character
character | |
---|---|
Type | Data |
Resolve List | item_list, online_status, friends, world, outfit, outfit_member |
Description | Contains all character-specific information. |
Structure | API/Collections/character |
Parameters | character id |
Example |
currency
currency | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all currencies in the game. Some of the currencies listed are not currently in use. |
Structure | API/Collections/currency |
Parameters | |
Example |
esamirmap
esamirmap | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all territories on Esamir. |
Structure | API/Collections/esamirmap |
Parameters | |
Example |
faction
faction | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all factions in the game. |
Structure | API/Collections/faction |
Parameters | |
Example |
icon.attachment
icon.attachment | |
---|---|
Type | Image |
Resolve List | None |
Description | A collection of images containing all attachment icons. |
Structure | API/Collections/icon.attachment |
Parameters | |
Example |
indarmap
indarmap | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all territories on Indar. |
Structure | API/Collections/indarmap |
Parameters | |
Example |
item
item | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all weapons and attachments in the game |
Structure | API/Collections/item |
Parameters | |
Example |
map
map | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of dynamic zone information (eg. who controls which sector), from a server and continent(s). |
Structure | API/Collections/map |
Parameters | world_id: Server ID, you can get this via the world collection.
zone_ids: List of continent IDs. The useful ones are: 2 = Indar, 6 = Amerish, 8 = Esamir |
Example |
profile
profile | |
---|---|
Type | Data |
Resolve List | None |
Description | Lists of weapons and cert descriptions, grouped by their item_class. Contains many weapons and certs not currently available in game. |
Structure | API/Collections/profile |
Parameters | |
Example |
profile.type
profile.type | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all infantry classes in the game. Some classes are not currently available. |
Structure | API/Collections/profile.type |
Parameters | |
Example |
resource
resource | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all resources in the game. Some of the resources listed are not currently available in game. |
Structure | API/Collections/resource |
Parameters | |
Example |
stat_info
stat_info | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of descriptions of the stats tracked inside the game client. |
Structure | API/Collections/stat_info |
Parameters | |
Example |
vehicle
vehicle | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all vehicles in the game. |
Structure | API/Collections/vehicle |
Parameters | |
Example |
zone
zone | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all zone/maps in the game. Contains many developer-only testing and development zones. |
Structure | API/Collections/zone |
Parameters | |
Example |
outfit
outfit | |
---|---|
Type | Data |
Resolve List | leader, member, rank, member_character |
Description | Contains information of all outfits in the game. The leader resolve will always resolve the founder of the outfit, even if there is more than one leader in an outfit. |
Structure | API/Collections/outfit |
Parameters | |
Example |
outfit_member
outfit_member | |
---|---|
Type | Data |
Resolve List | character, online_status, outfit |
Description | Contains a list of all characters in outfits in the game. |
Structure | API/Collections/outfit_member |
Parameters | |
Example |
outfit_rank
outfit_rank | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all ranks of all outfits in the game. |
Structure | API/Collections/outfit_rank |
Parameters | |
Example |
characters_online_status
characters_online_status | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains online/offline status of all characters. |
Structure | API/Collections/characters_online_status |
Parameters | |
Example |
characters_friend
characters_friend | |
---|---|
Type | Data |
Resolve List | character, world |
Description | Contains the friend lists of all characters. |
Structure | API/Collections/characters_friend |
Parameters | |
Example |
characters_world
characters_world | |
---|---|
Type | Data |
Resolve List | None |
Description | Resolves which world a character is on when passed a character id. |
Structure | API/Collections/characters_world |
Parameters | |
Example |
leaderboard
leaderboard | |
---|---|
Type | Data |
Resolve List | character, world |
Description | Contains all daily, weekly and monthly leaderboard information. |
Structure | API/Collections/leaderboard |
Parameters | |
Example |
characters_leaderboard
characters_leaderboard | |
---|---|
Type | Data |
Resolve List | None |
Description | |
Structure | API/Collections/characters_leaderboard |
Parameters | |
Example |
characters_event_grouped
characters_event_grouped | |
---|---|
Type | Data |
Resolve List | character |
Description | Contains grouped character specific events. For example, how many times a character has been killed by another character. |
Structure | API/Collections/characters_event_grouped |
Parameters | |
Example |
characters_event
characters_event | |
---|---|
Type | Data |
Resolve List | character, attacker |
Description | Contains all events specific to a character. |
Structure | API/Collections/characters_event |
Parameters | |
Example |
event
event | |
---|---|
Type | Data |
Resolve List | character, attacker |
Description | Contains all events. |
Structure | API/Collections/event |
Parameters | |
Example |
world
world | |
---|---|
Type | Data |
Resolve List | None |
Description | Contains a list of all servers and their online/offline status. |
Structure | API/Collections/world |
Parameters | |
Example |