Skip to content

Latest commit

 

History

History
1254 lines (1147 loc) · 122 KB

api-parameter-details.md

File metadata and controls

1254 lines (1147 loc) · 122 KB

API Parameter Details

Response Type

string

The API supports both JSON and XML responses. However, we strongly suggest only using JSON when requesting resources.

Avatar Id - Paladins

int

Avatars

Valid values are:

IDNameImage
0Default
9918Origin
23120Cosplay
23203VIP
23209Striker
23226Terminating
23442Corrupter
23549The Lost Hand
23550Oni Mask
23552Cutesy Maeve
23553Cutesy Snek
23554Cutesy Zhin
23555Goodnight
23564Shadowblade
23661Flametongue
23662Snack Time
23714Death Speaker
23715Knightmare
23716Day Walker
23717Harbinger
23924Synth
23925Nom Nom
24079Cutesy Yeti
24080Cutesy Lian
24081Rowdy Corsair
24088Winter Workout
24120Suit Up
24143Shield Bearer
24164The King
24165Poppy
24166Greenwood Friend
24167White Knight
24168Masterpiece
24169Battle Rage
24170Groverling
24171Forkasen Wanderer
24172Kitten
24173Tigron Thief
24174I WUV YOU
24175Tepid Friendship
24176Vulpin
24177Dumpster Diver
24178Abyssal Vessel
24179The Returned
24180Twilight Assassin
24181Happy Huntress
24182The Blossom
24183Mirror Mirror
24202Paladins Defense Force
24203Imperial Magistrate
24204Fire And Ice
24241Assembly of Champions
24350Queen of Hearts
24354Future's Protector
24355Squidly
24356Forlorn Future
24375Dragon Queen
24393Diamond Badge
24394Gold Badge
24482Blue Warrior
24505How Quaint
24597Champions are Eternal
24611Best Boy
24612Summer Blossom
24669Vanguard
24678Bubbles
24679Baby Steps
24680Dragon Forged
24681Dwarven Strength
24709Unrelenting
24758Charming
24759Sunset
24760Lifesaver
24824Beach Vibes
24887Groovy Grover
24888Grohk Rock
24889Celebrity Io
24890Popstar Skye
24891Greaser Lex
24892Fallen Champion
24897Reckoning
24898Resolute
24969Redbeard
24970Bubbly
24972Pirateer
24973Kitsune
25021Blu
25022Molly the Shark
25138Suave Saguaro
25139Wanted Man
25140Bandit's Fury
25141Smoked
25161Lenny the Pirate
25222Goddess of Death
25223Ska'drin Ash
25224Dark Monarch
25225Soul Briar
25226Wukong
25227Mischievous
25228Forest Protector
25229Ice Box
253422019 Charity Avatar
25355Adanas The Balance Master
25356Gentleman Raum
25357Tyra-nova
25421Four Leaf Grover
25422Termineaster
25434Temple Guardian
25435Devious
25437Divine Priestess
25438The Risen
25506Scaled Menace
25507Hunter's Fury
25545Brood-Guard
25546Eye of Saurus
26291Survivor
26325Captain's Guile
26326Unstable Power
26346Devotion
26347Spirit
26348Determination
26349Passion
26350Under the Sea
26351Starry Eyed
26352Serene
26510LGBTQIA+ Pride
26521Winner Winner
26759Blazing Spirit
26760Dark Gaze
26761Lily-hopper
26762Knowledge-Seeker
26763Trailblazer
26764Ember
26769Festive Menorah
26770First Fruits
26771Holiday Cheer
26772Ruckus' New Year
26774Beevie
26776Harbinger of the End
26779Bisexual Pride
26780Asexual Pride
26781Transgender Pride
26782Non-Binary Pride
26783Lesbian Pride
26784Pansexual Pride
26875Dark Deeds
26876Beauty in Conflict
26877Relic of Salvation
26878Penitence
26879Uplifting Grace
26967Self-Sufficient
26969The Maw
26972Charmed, I'm Sure
26973Magic Easter Moji
26974Lunar New Year
26975Ramadan
26976Will U B Mine?
27097Virtual Pilot
27098Raum.hack
27099Multiplayer
27111Birthday Party Cassie
27112Birthday Party Mal'Damba
27113Birthday Party Moji
27114Birthday Party Io
27115Birthday Party Buck
27116Birthday Party Vora
27117Birthday Party Luna
27118Birthday Party Pip and Pepper
27119Birthday Party Ying
27120Birthday Party Yagorath
27121Digital Space
27122E-motions
27123Malicious Software
27124Dev Environment
27258Deep Dive
27259Sun, Sand, and Salt
27260Summer Breeze
27393Chibi Chase
27394Chibi Valentina
27395Chibi Cammie
27396Chibi Yaz
27397Chibi Kazu
27398Dedicated
27405Schism
27450Adorable
27469Finch
27642Hallowed Rei
27643Hallowed Pip
27644Hallowed Androxus
27645Hallowed Evie
27646Autumn Maeve
27647Hallowed Io
27648Hallowed Willo
27649Hallowed Corvus
27650Hallowed Vatu
27651Hallowed Talus
27652Straight Ally Pride
27653Genderqueer Pride
27654Polysexual Pride
27655Genderfluid Pride
27656Agender Pride
27657Demisexual Pride
27658That Damned Smile
27659Life and Death
27660Hidden Desires
27819Sea Queen's Gaze
27821Snuggle Up
27824Better
27889Moji
27890Ash
27891Cassie
27892Grohk
27893Grover
27894Makoa
27895Mal'Damba
27896Bomb King
28041Floating Lucipurr
28042Maeve Charm
28044Pensive
28045Year of the Tigron
28046Insert Coin
28047Target Acquired
28049St. Barik's Day
28050Lovely Saati
28051Lovely Azaan
28052Lovely Io
28053Lovely Raum
28054Fauxll
28055Lovely Zigs
28056Lovely Viktor
28057Lovely Mal'Damba
28058Lovely Ash
28059Lovely Sha Lin
28061Final Test
28062Valentine's Day 2022
30652Atlas
30653Furia/Seris
30654Imani
30655Jenos
30656Lian
30657Skye
30658Vora
30659Ruckus
30662Bossfight Koga
30663WHIPPED CREAM Cassie
30664Monstercat Vibe
30665GG Magree Skye
30666Easter 2022
30667Ramadan 2022
30877Dark Embrace Io
30879Dark Embrace Bomb King
30880Queen of the Knight
30881Seeker's Gaze
30882Eyes of the Beholder
31016Blake Belladonna
31017Yang Xiao Long
31018Weiss Schnee
31019Qrow Branwen
31020Ruby Rose
31021Salem, the Witch
31226Io Love You
31227A-Vora-Ble
31228Feeling Cute
31229Stellar Gaze
31230Echoes of Ascension
31231Dashing Duelist
31455Kasumi
31480Abyss Cultist
31481Soulweaver
31482Oni Tiberius
31483Karasu
31676Eternal Prisoner
31678Mine Forever
31682Feathered Feast
31684From The Ashes
31685Teasing Tresses
MISSINGBug Out
MISSINGZephyr
MISSINGClass Puppet
MISSINGDark Embrace Pip
MISSINGEye Captain
MISSINGJustin OH Khan
MISSINGLurking
MISSINGSweet Lucipurr

Character

int

The God ID is an unique id for each playable character in a game.

Can be obtained from:

Character - Paladins

int

Champions are the playable characters in Paladins.

Each one has their own unique abilities and fighting style. Champions use Cards to increase their performance and enhance their skills, and Items to help them adapt to specific situations in every match.

Champions

Champions are organized into 4 different classes:

  • Damage: These champions can consistently deal high amounts of damage. Damage champions gain 100% more [Credits][credits] for dealing damage to enemy champions.
  • Flank: These champions excel in both damage and mobility to help them in combat as well as chase and confirm kills from the enemy's rear. However, their low health makes them vulnerable to getting overwhelmed by multiple enemies. Flank champions gain 30% more [Credits][credits] from landing killing blows on enemies.
  • Front Line: These champions are the best at maintaining control of objectives and protecting their teammates through shields, personal force fields, or just by taking fire. Front Line champions gain 100% more [Credits][credits] for standing near an objective.
  • Support: These champions offer a wide range of utility, both offensive and defensive. However, they specialize in healing and causing chaos in enemy attacks. Support champions gain 100% more [Credits][credits] for healing allies, and eliminations from healing a target that gets the killing blow on an enemy. Support champions also gain ultimate charge from healing done to teammates besides themselves. Healing that restores 0 Health (for example, healing someone who is at full health) won't provide ultimate charge.

There are currently 57 playable champions in the game (Updated in 11/08/2022 05:17:32):

IDNameRoleTitlePortraitHeaderCarouselBackground
2056PipSupportThe Rogue Alchemist
2057SkyeFlankThe Twilight Assassin
2071FernandoFront LineThe Self-Appointed Knight
2073BarikFront LineThe Master Mechanic
2092CassieDamageThe Hunter's Daughter
2093GrohkSupportThe Lightning Orc
2094EvieFlankThe Winter Witch
2147BuckFlankThe Unyielding
2149RuckusFront LineThe Worst of Friends
2205AndroxusFlankThe Godslayer
2249KinessaDamageThe Bounty Hunter
2254GroverSupportThe Wild
2267YingSupportThe Blossom
2277DrogozDamageThe Greedy
2281Bomb KingDamageHis Majesty
2285ViktorDamageThe Lone Wolf
2288MakoaFront LineThe Ancient
2303Mal'DambaSupportWekono's Chosen
2307Sha LinDamageThe Desert Wind
2314TyraDamageThe Untamed
2322TorvaldFront LineThe Runic Sage
2338MaeveFlankof Blades
2348InaraFront LineThe Stone Warden
2362LexFlankThe Hand of Justice
2372SerisSupportOracle of the Abyss
2393WilloDamageof the Summer Court
2404AshFront LineThe War Machine
2417LianDamageScion of House Aico
2420ZhinFlankThe Tyrant
2431JenosSupportThe Ascended
2438StrixDamageGhost Feather
2472TalusFlankof the Ska'drin
2477TerminusFront LineThe Fallen
2479KhanFront LinePrimus of house Aico
2480VivianDamageThe Cunning
2481MojiFlankand Friends
2491FuriaSupportAngel of Vengeance
2493KogaFlankThe Lost Hand
2495DredgeDamageAdmiral of the Abyss
2509ImaniDamageThe Last Warder
2512AtlasFront LineThe Man Out of Time
2517IoSupportthe Shattered Goddess
2528RaumFront LineRage of the Abyss
2529TiberiusDamageThe Weapons Master
2533CorvusSupportThe Magistrate's Blade
2536VoraFlankThe Harbinger
2538YagorathFront LineThe Devourer
2540OctaviaDamageThe Indomitable
2541VatuFlankThe Shadow
2542ReiSupportScholar of House Aico
2543SaatiDamageThe Trickshot
2548AzaanFront LineThe Eternal
2549VIIFlankRight Hand of the Tribunal
2550Betty la BombaDamageThe Bomb Queen
2551LillithSupportThe Heartless
2554CaspianFlankThief of Hearts (and Treasure)
2555KasumiDamageDeath's Howl

Character - Realm Royale

int

There are multiple Classes in Realm Royale.

Each one has its own unique abilities and fighting style. Each class has a unique passive bonus, movement ability, and 4 special abilities.
Additionally each class can craft a unique weapon at the forge.

Classes

There are currently 4 playable classes in the game:

IDNameIn-Game NameImage
2285Male TankWarrior
2493Female DamageHunter
2494Female SupportMage
2496Male FlankAssassin

Character - Smite

int

Gods are the playable characters in Smite.

Each god is unique, with different strengths and weaknesses, and their own playstyle. The statistics of certain gods are geared for offense, while others are better suited for defense.

Gods

Gods are organized in 5 different classes:

  • Assassins (mostly melee junglers and gankers).
  • Guardians (mostly melee supports, tanks and initiators).
  • Hunters (mostly ranged carries and fighters).
  • Mages (mostly ranged spellcasters).
  • Warriors (mostly melee bruisers).

There are currently 123 playable gods in the game (Updated in 11/08/2022 05:18:26):

IDNameRoleTitleImage
1649KaliAssassinGoddess of Destruction
1668AnubisMageGod of the Dead
1669OdinWarriorThe Allfather
1670YmirGuardianFather of the Frost Giants
1672ZeusMageGod of the Sky
1673Hun BatzAssassinthe Howler Monkey God
1674He BoMageGod of the Yellow River
1676HadesMageKing of the Underworld
1677KukulkanMageSerpent of the Nine Winds
1678BastetAssassinGoddess of Cats
1698RaMageSun God
1699ArachneAssassinthe Weaver
1718HelMageGoddess of the Underworld
1723VamanaWarriorFifth Avatar of Vishnu
1737AgniMageGod of Fire
1747SobekGuardianGod of the Nile
1748ArtemisHunterGoddess of the Hunt
1755BakasuraAssassinthe Great Devourer
1763Guan YuWarriorSaint of War
1773AnhurHunterSlayer of Enemies
1778CupidHunterGod of Love
1779ThorAssassinGod of Thunder
1782AresGuardianGod of War
1784FreyaMageQueen of the Valkyries
1797LokiAssassinThe Trickster God
1809BacchusGuardianGod of Wine
1843FenrirAssassinthe Unbound
1848HerculesWarriorChampion of Rome
1864XbalanqueHunterHidden Jaguar Sun
1869VulcanMageSmith of the Gods
1872NeithHunterWeaver of Fate
1881PoseidonMageGod of the Oceans
1898AphroditeMageGoddess of Beauty
1899ApolloHunterGod of Music
1915Ne ZhaAssassinthe Third Lotus Prince
1918IsisMageGoddess of Magic
1919AthenaGuardianGoddess of Wisdom
1920ChronosMageKeeper of Time
1921Chang'eMageFaerie of the Moon
1924TyrWarriorthe Lawgiver
1926Zhong KuiMagethe Demon Queller
1941MercuryAssassinMessenger of the Gods
1943ThanatosAssassinHand of Death
1944Sun WukongWarriorthe Monkey King
1956Ah Muzen CabHunterGod of Bees
1958Nu WaMageGuardian of Heaven
1966ChaacWarriorGod of Rain
1978GebGuardianGod of Earth
1980NemesisAssassinGoddess of Vengeance
1988ScyllaMageHorror of the Sea
1991UllrHunterThe Glorious One
1993KumbhakarnaGuardianThe Sleeping Giant
1999JanusMageGod of Portals and Transitions
2000OsirisWarriorBroken God of the Afterlife
2002RamaHunterSeventh Avatar of Vishnu
2005SerqetAssassinGoddess of Venom
2008CabrakanGuardianDestroyer of Mountains
2030SylvanusGuardianKeeper of the Wild
2034Ao KuangMageDragon King of the Eastern Seas
2036NoxMageGoddess of Night
2037AwilixAssassinGoddess of the Moon
2040Hou YiHunterDefender of the Earth
2047BellonaWarriorGoddess of War
2051MedusaHunterThe Gorgon
2056Ah PuchMageHorrific God of Decay
2063RatatoskrAssassinThe Sly Messenger
2065RavanaAssassinDemon King of Lanka
2066KhepriGuardianThe Dawn Bringer
2072Xing TianGuardianThe Relentless
2074SolMageGoddess of the Sun
2075ChironHunterThe Great Teacher
2107SkadiHunterGoddess of Winter
2110AmaterasuWarriorThe Shining Light
2113RaijinMageMaster of Thunder
2122Jing WeiHunterThe Oathkeeper
2123SusanoAssassinGod of the Summer Storm
2136FafnirGuardianThe Lord of Glittering Gold
2138Erlang ShenWarriorThe Illustrious Sage
2147TerraGuardianThe Earth Mother
2179IzanamiHunterMatron of the Dead
2189CamazotzAssassinDeadly God of Bats
2203ThothMageArbiter of the Damned
2214NikeWarriorGoddess of Victory
2226The MorriganMagePhantom Queen
2260KuzenboGuardianKing Kappa
2268CernunnosHunterThe Horned God
2269GaneshaGuardianGod of Success
2270Da JiAssassinThe Nine-Tailed Fox
2319Cu ChulainnWarriorHound of Ulster
3336ArtioGuardianThe Bear Goddess
3344HachimanHunterLord of the Eight Banners
3377DiscordiaMageGoddess of Strife
3419CerberusGuardianWarden of the Underworld
3492AchillesWarriorHero of the Trojan War
3509ChernobogHunterLord of Darkness
3518Baron SamediMageGod of Life and Death
3543PeleAssassinGoddess of Volcanoes
3558HeraMageQueen of the Gods
3565King ArthurWarriorWielder of Excalibur
3566MerlinMageThe Master Wizard
3585JormungandrGuardianThe World Serpent
3611HorusWarriorThe Rightful Heir
3612SetAssassinThe Usurper
3664OlorunMageRuler of the Heavens
3705PersephoneMageQueen of the Underworld
3811YemojaGuardianGoddess of Rivers
3812HeimdallrHunterThe Vigilant
3881MulanWarriorThe Ascendant Warrior
3925Baba YagaMageWitch of the Woods
3945CthulhuGuardianThe Great Dreamer
3954TsukuyomiAssassinGod of the Moon
3984DanzaburouHunterThe Legendary Tanuki
3990TiamatMageGoddess of the Salt Sea
3997GilgameshWarriorKing Of Uruk
4006Morgan Le FayMageThe Dark Enchantress
4010CharybdisHunterThe Ceaseless Whirlpool
4017CliodhnaAssassinQueen of the Banshees
4034AtlasGuardianTitan of the Cosmos
4039ShivaWarriorThe Destroyer
4060Yu HuangMageThe Jade Emperor
4075LancelotAssassinFirst Knight of the Round Table
4137IshtarHunterGoddess of Love and War
4183MauiGuardianHero of Hawai‘i

Date Format 📅

string

A DateTime in the following format: yyyyMMdd - “20191210” (for Dec 10, 2019, as an example)

Hour ⌚

string

Valid values: 0 - 23. An hour parameter of -1 represents the entire day, but be warned that this may be more data than we can return for certain queues.

To avoid HTTP timeouts in the GetMatchIdsByQueue method, you can now specify a 10-minute window within the specified {hour} field to lessen the size of data returned by appending a “,mm” value to the end of {hour}. For example, to get the match Ids for the first 10 minutes of hour 3, you would specify {hour} as “3,00”. This would only return the Ids between the time 3:00 to 3:09. Rules below:

  • Only valid values for mm are “00”, “10”, “20”, “30”, “40”, “50”
  • To get the entire third hour worth of Match Ids, call GetMatchIdsByQueue 6 times, specifying the following values for {hour}: “3,00”, “3,10”, “3,20”, “3,30”, “3,40”, “3,50”.
  • The standard, full hour format of {hour} = “hh” is still supported.

Game Mode

int

The queue_id is an unique id for each playable game mode in a game (last updated 2019-12-10).

Game Mode - Paladins

int

Game Modes
IDNameDescriptionImage
423 Custom Siege - Stone Keep This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
424 LIVE Siege Siege is a round based game mode where each team works to earn Objective Points to win the match, the first team to achieve 4 Objective Points wins.
Players can change their Cards loadout at the start of the match.
These points are earned by taking control of a Capture Point, escorting the Payload into the enemy team's base and Stalling the enemy team's Payload until the time runs out.
425 LIVE Siege Pratice This version of Siege is Co-op vs AI.
426 Custom Siege - Bazaar This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
428 LIVE Competitive Gamepad This version of Ranked is reserved for consoles players.
430 Custom Siege - Timber Mill This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
431 Custom Siege - Fish Market This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
432 Custom Siege - Frozen Guard This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
433 Custom Siege - Frog Isle This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
434 Shooting Range The Shooting Range, a special map designed to test out champions.
438 Custom Siege - Jaguar Falls This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
439 Custom Siege - Ice Mines This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
440 Custom Siege - Serpent Beach This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
444 Basic Tutorial The Basic Tutorial explains the controls of Paladins to the player.
445 LIVE Test Maps This version of Siege allows players to test maps that are still in early development and can give feedback.
452 LIVE Onslaught - King of the Hill Onslaught is a queue, that features a classic King of the Hill gameplay and a variant thereof.
To win, players must earn tickets by either killing players or controlling a Capture Point.
The first team to reach 400 tickets, or the team with the most tickets until time runs out, wins.
453 LIVE Onslaught Pratice This version of Onslaught is Co-op vs AI.
454 Custom Onslaught - Snowfall Junction This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
455 Custom Onslaught - Primal Court This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
458 Custom Siege - Brightmarsh This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
459 Custom Siege - Splitstone Quarry This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
462 Custom Onslaught - Foreman's Rise This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
464 Custom Onslaught - Magistrate's Archives This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
468 Custom Team Deathmatch - Trade District This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
469 LIVE Team Deathmatch Team Deathmatch is a classic deathmatch game mode, the first team to achieve 40 kills wins.
470 LIVE Team Deathmatch Pratice This version of Team Deathmatch is Co-op vs AI.
471 Custom Team Deathmatch - Foreman's Rise This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
472 Custom Team Deathmatch - Magistrate's Archives This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
473 Custom Siege - Ascension Peak This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
479 Custom Team Deathmatch - Abyss This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
480 Custom Team Deathmatch - Throne This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
483 Custom Onslaught - Marauders Port This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
484 Custom Team Deathmatch - Dragon Arena This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
485 Custom Siege - Warders Gate This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
486 LIVE Competitive KBM Ranked is a system in Paladins designed to provide higher quality matches for competitive players. The current Season of competitive play is 3.
487 Custom Siege - Shattered Desert This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
10200 Custom King of the Hill - Magistrate's Archives This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
10201 Custom King of the Hill - Snowfall Junction This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
10202 Custom King of the Hill - Marauders Port This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.
10203 Custom King of the Hill - Trade District This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches.

Game Mode - Realm Royale

int

Game Modes
IDNameDescription
474LIVE SoloA mode where you fly solo. No teammates, just you and your gun against 99 other solos.
475LIVE DuoA mode where teams of two play to the end with 49 other duos.
476LIVE QuadA mode where teams of four battle it out against 24 other squads.
477Live Wars
478Live Tutorial
479Live Solo Mid Level
480Live Solo Low Level
481Live Squad Mid Level
482Live Squad Low Level
483Live Duo Mid Level
484Live Duo Low Level
10188Custom Game Solo
10189Custom Game Duo
10190Custom Game Quad
10205Custom Game Trio

Language 🌐

int

The language Id that you want results returned in. Default is 1.

Languages

Valid values are:

IDLanguageNameFlag
1Englishen_US🇺🇸
2GermanDeutschde_DE🇩🇪
3FrenchFrançaisfr_FR🇫🇷
5Chinesezh_CN🇨🇳
7Spanishes_ES🇪🇸
9Spanish (Latin America)Españoles_LA🇦🇷
10PortuguesePortuguês do Brasilpt_BR🇧🇷
11RussianРусскийru_RU🇷🇺
12PolishPolskipl_PL🇵🇱
13TurkishTürkçetr_TR🇹🇷

Match ID

int: The id of a match.

The Match ID is an unique id for each map that’s created by the server for a set of players.

The “match_id” can be obtained from:

Player

This may either be:

Player Name

string

This is the Player Name.

Player ID

int

The Player ID is an unique id for each player that's is created and internally stored by Hi-Rez.

The “player_id” can be obtained from:

Portal User Id

The (usually) 3rd-Party identifier for a Portal. Examples: Steam ID, PS4 GamerTag, Xbox GamerTag, Switch GamerTag.

Steam ID

int

This is the Player Steam ID.

Gamer Tag

string

Typically an alphanumeric descriptor of an individual on a Portal. This value might not be unique depending on Portal.

Portal

int

A “Portal” is a gateway into our games via an identifier. In the past it would have been synonymous with a hardware platform... but because of gateways such as “Steam” it is more than just a hardware platform.

Represents Platform as follows:

IDPlatformImage
1Hi-Rez
5Steam
9Play Station
10Xbox
14Mixer
22Nintendo Switch
25Discord
28Epic Games

Season

int

The season of a league. Starts at 1 and increases by 1 for each calendar year.

  • Paladins: As of 2019-12-09 we are currently on season 3.
  • Smite: As of 2019-12-09 we are currently on season 6.

League Tier

int

Tiers

Valid values are:

IDDescriptionImage
0Unranked
1Bronze V
2Bronze IV
3Bronze III
4Bronze II
5Bronze I
6Silver V
7Silver IV
8Silver III
9Silver II
10Silver I
11Gold V
12Gold IV
13Gold III
14Gold II
15Gold I
16Platinum V
17Platinum IV
18Platinum III
19Platinum II
20Platinum I
21Diamond V
22Diamond IV
23Diamond III
24Diamond II
25Diamond I
26Master
27Grandmaster

Status

int

Represents Player Status as follows:

IDTypeDescription
0Offline
1In LobbyBasically anywhere except god selection or in game.
2God SelectionPlayer has accepted match and is selecting god before start of game.
3In GameMatch has started.
4OnlinePlayer is logged in, but may be blocking broadcast of player state.
5UnknownPlayer not found.

Signature

string

The Signature is created by concatenating several fields and then hashing the result with an MD5 algorithm.

A distinct signature is required for each API method called.

The components of this hash are (in order):

Name Description Example
dev_id “1004”
method Which “method” means the resource you want to retrieve data
This will not include the Response Type, just the name of the method.
“createsession”
auth_key “23DF3C7E9BD14D84BF892AD206B6755C”
timestamp Current UTC Timestamp “20191128030916”
C# Sample
private static string generate_signature(int dev_id, string method, string auth_key, string timestamp) {
  using (var md5 = System.Security.Cryptography.MD5.Create()) {
    var bytes = md5.ComputeHash(System.Text.Encoding.UTF8.GetBytes(dev_id + method + auth_key.ToLower() + timestamp));
    var string_builder = new System.Text.StringBuilder();
    foreach (byte b in bytes)
      string_builder.Append(b.ToString("x2").ToLower());
    return string_builder.ToString();
  }
}
var signature = generate_signature(1004, "createsession", "23DF3C7E9BD14D84BF892AD206B6755C", get_timestamp());
Java Sample
private static String generate_signature(int dev_id, String auth_key, String method, String timestamp) {
  String template_signature = dev_id + method + auth_key + timestamp;
  StringBuilder string_builder = new StringBuilder();
  try {
    MessageDigest md = MessageDigest.getInstance("MD5");
    md.update (template_signature.getBytes());
    byte [] bytes = md.digest();

    for (byte b : bytes) {
      String hex = Integer.toHexString(0xff & b);
      if (hex.length () == 1)
        string_builder.append("0");
      string_builder.append(hex);
    }
  } catch (NoSuchAlgorithmException e) {
    e.printStackTrace();
  }

  return string_builder.toString();
}

public final String signature = generate_signature(1004, "createsession", "23DF3C7E9BD14D84BF892AD206B6755C", get_timestamp());
Javascript Sample
const md5 = require("md5");
function generate_signature(dev_id, method, auth_key, timestamp) {
  return md5(`${dev_id}${method}${auth_key}${timestamp}`);
}
var signature = generate_signature(1004, "createsession", "23DF3C7E9BD14D84BF892AD206B6755C", get_timestamp());
PHP Sample
private function generate_signature($dev_id, $method, $auth_key, $timestamp) {
    return md5($dev_id . $method . $auth_key . $timestamp);
}
Python Sample
from hashlib import md5
def generate_signature(dev_id, method, auth_key, timestamp):
	return md5(f'{dev_id}{method.lower()}{auth_key}{timestamp}'.encode('utf-8')).hexdigest()
signature = generate_signature(1004, 'createsession', '23DF3C7E9BD14D84BF892AD206B6755C', get_timestamp())

Timestamp

string

Current UTC time (GMT+0) in the following format: “yyyyMMddHHmmss”.

Timestamps are used by Signatures and embedded into URLs when sending requests, they have to be formatted properly to ensure the request completes without error.

C# Sample
public static string get_timestamp(string _format="yyyyMMddHHmmss") {
  return System.DateTime.UtcNow.ToString(_format);
}
var timestamp = get_timestamp();
Java Sample
private static String get_timestamp() {
  SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMddHHmmss");
  sdf.setTimeZone(new SimpleTimeZone(SimpleTimeZone.UTC_TIME, "UTC"));
  return sdf.format(new Date());
}
public final String timestamp = get_timestamp();
Javascript Sample
const moment = require("moment");
function get_timestamp() {
  return moment.utc().format("yyyyMMddHHmmss");
}
var timestamp = get_timestamp();
PHP Sample
private function get_timestamp() {
  return Carbon::now()->format('Ymdhis');
}
Python Sample
from datetime import datetime
def get_timestamp(_format='%Y%m%d%H%M%S'):
  return datetime.utcnow().strftime(_format)
timestamp = get_timestamp()