cod-python-api

---

Call Of Duty API Library for python with the implementation of both public and private API used by activision on callofduty.com

Devs

Todo Lodo and Engineer15

Partnered Code

Node-CallOfDuty by: Lierrmm

Documentation

This package can be used directly as a python file or as a python library.

Installation

Install cod-api library using pip:

pip install -U cod-api

Usage

Initiation

Import module with its classes:

from cod_api import API

api = API()

Login with your sso token:

api.login('Your sso token')

Your sso token can be found by longing in at callofduty, opening dev tools (ctr+shift+I), going to Applications > Storage > Cookies > https://callofduty.com, filter to search 'ACT_SSO_COOKIE' and copy the value.

Game/Other sub classes

Following importation and initiation of the class API, its associated subclasses can be called by API.subClassName.

Below are the available sub classes:

sub class	catogery
ColdWar	game
ModernWarfare	game
Vanguard	game
Warzone	game
Me	other
Shop	other
Misc	other

For a detailed description, __doc__ (docstring) of each sub class can be called as shown below:

ColdWar:

from cod_api import API

api = API()

# print out the docstring
print(api.ColdWar.__doc__)

ModernWarfare:

from cod_api import API

api = API()

# print out the docstring
print(api.ModernWarfare.__doc__)

Vanguard:

from cod_api import API

api = API()

# print out the docstring
print(api.Vanguard.__doc__)

Warzone:

from cod_api import API

api = API()

# print out the docstring
print(api.Warzone.__doc__)

Me:

from cod_api import API

api = API()

# print out the docstring
print(api.Me.__doc__)

Shop:

from cod_api import API

api = API()

# print out the docstring
print(api.Shop.__doc__)

Misc:

from cod_api import API

api = API()

# print out the docstring
print(api.Misc.__doc__)

Combat History

Any sub class of API that is of game catogery, has methods to check a player's combat history. Note that before calling any sub class methods of API you must be logged in. Main methods are combatHistory() and combatHistoryWithDate() which are available for all ColdWar, ModernWarfare, Vanguard and Warzone classes.

The combatHistory() takes 2 input parameteres which are platform and gamertag of type cod_api.platforms and string respectively.

Here's an example for retrieving Warzone combat history of a player whose gamer tag is Username#1234 on platform Battlenet:

from cod_api import API, platforms

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving combat history
hist = api.Warzone.combatHistory(platforms.Battlenet, "Username#1234") # returns data of type dict

# printing results to console
print(hist)

The combatHistoryWithDate() takes 4 input parameteres which are platform, gamertag, start and end of type cod_api.platforms, string, int and int respectively.

start and end parameters are utc timestamps in microseconds.

Here's an example for retrieving ModernWarfare combat history of a player whose gamer tag is Username#1234567 on platform Activision with in the timestamps 1657919309 (Friday, 15 July 2022 21:08:29) and 1657949309 (Saturday, 16 July 2022 05:28:29):

from cod_api import API, platforms

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving combat history
hist = api.Warzone.combatHistoryWithDate(platforms.Activision, "Username#1234567", 1657919309, 1657949309) # returns data of type dict

# printing results to console
print(hist)

Additionally the methods breakdown() and breakdownWithDate() can be used to retrieve combat history without details, where only the platform played on, game title, UTC timestamp, type ID, match ID and map ID is returned for every match. And just like combatHistory() and combatHistoryWithDate() these methods are available for all ColdWar, ModernWarfare, Vanguard and Warzone classes.

The breakdown() takes 2 input parameteres which are platform and gamertag of type cod_api.platforms and string respectively.

Here's an example for retrieving Warzone combat history breakdown of a player whose gamer tag is Username#1234 on platform Battlenet:

from cod_api import API, platforms

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving combat history breakdown
hist_b = api.Warzone.breakdown(platforms.Battlenet, "Username#1234") # returns data of type dict

# printing results to console
print(hist_b)

The breakdownWithDate() takes 4 input parameteres which are platform, gamertag, start and end of type cod_api.platforms, string, int and int respectively.

start and end parameters are utc timestamps in microseconds.

Here's an example for retrieving ModernWarfare combat history breakdown of a player whose gamer tag is Username#1234567 on platform Activision with in the timestamps 1657919309 (Friday, 15 July 2022 21:08:29) and 1657949309 (Saturday, 16 July 2022 05:28:29):

from cod_api import API, platforms

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving combat history breakdown
hist_b = api.Warzone.breakdownWithDate(platforms.Activision, "Username#1234567", 1657919309, 1657949309) # returns data of type dict

# printing results to console
print(hist_b)

Match Details

To retrieve details of a specific match, the method matchInfo() can be used and this is available for all ColdWar, ModernWarfare, Vanguard and Warzone classes. Details returned by this method contains additional data than that of details returned by the methods combatHistory() and combatHistoryWithDate() for a single match.

The matchInfo() takes 2 input parameteres which are platform and matchId of type cod_api.platforms and integer respectively.

Optionally the match ID can be retrieved during your gameplay where it will be visible on bottom left corner

Here's an example for retrieving Warzone match details of a match where its id is 9484583876389482453 on platform Battlenet:

from cod_api import API, platforms

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving match details
details = api.Warzone.matchInfo(platforms.Battlenet, 9484583876389482453) # returns data of type dict

# printing results to console
print(details)

Season Loot

Using the seasonLoot() method a player's obtained season loot can be retrieved for a specific game and this method is available for ColdWar, ModernWarfare and Vanguard classes.

The seasonLoot() takes 2 input parameteres which are platform and matchId of type cod_api.platforms and integer respectively.

Here's an example for retrieving ColdWar season loot obtained by a player whose gamer tag is Username#1234 on platform Battlenet:

from cod_api import API, platforms

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving season loot
loot = api.ColdWar.seasonLoot(platforms.Battlenet, "Username#1234") # returns data of type dict)

# printing results to console
print(loot)

Map List

Using the mapList() method all the maps and its available modes can be retrieved for a specific game. This method is available for ColdWar, ModernWarfare and Vanguard classes.

The mapList() takes 1 input parameteres which is platform of type cod_api.platforms.

Here's an example for retrieving Vanguard map list and available modes respectively on platform PlayStation (PSN):

from cod_api import API, platforms

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving maps and respective modes available
maps = api.Vanguard.mapList(platforms.PSN) # returns data of type dict)

# printing results to console
print(maps)

platforms

platforms is an enum class available in cod_api which is used to specify the platform in certain method calls.

Available platforms are as follows:

Platform	Remarks
platforms.All	All (no usage till further updates)
platforms.Activision	Activision
platforms.Battlenet	Battlenet
platforms.PSN	PlayStation
platforms.Steam	Steam (no usage till further updates)
platforms.Uno	Uno (activision unique id)
platforms.XBOX	Xbox

platforms can be imported and used as follows:

from cod_api import platforms

platforms.All        # All (no usage till further updates)

platforms.Activision # Activision

platforms.Battlenet  # Battlenet

platforms.PSN        # PlayStation

platforms.Steam      # Steam (no usage till further updates)

platforms.Uno        # Uno (activision unique id)

platforms.XBOX       # Xbox

User Info

Using the info() method in sub class Me of API user information can be retrieved of the sso-token logged in with

from cod_api import API

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving user info
userInfo = api.Me.info() # returns data of type dict

# printing results to console
print(userInfo)

User Friend Feed

Using the friendFeed() method in sub class Me of API user's friend feed can be retrieved of the sso-token logged in with

from cod_api import API

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving user friend feed
friendFeed = api.Me.friendFeed() # returns data of type dict

# printing results to console
print(friendFeed)

User Event Feed

Using the eventFeed() method in sub class Me of API user's event feed can be retrieved of the sso-token logged in with

from cod_api import API

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving user event feed
eventFeed = api.Me.eventFeed() # returns data of type dict

# printing results to console
print(eventFeed)

User Identities

Using the loggedInIdentities() method in sub class Me of API user's identities can be retrieved of the sso-token logged in with

from cod_api import API

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving user identities
identities = api.Me.loggedInIdentities() # returns data of type dict

# printing results to console
print(identities)

User COD Points

Using the codPoints() method in sub class Me of API user's cod points can be retrieved of the sso-token logged in with

from cod_api import API

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving user cod points
cp = api.Me.codPoints() # returns data of type dict

# printing results to console
print(cp)

User Accounts

Using the connectedAccounts() method in sub class Me of API user's connected accounts can be retrieved of the sso-token logged in with

from cod_api import API

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving user connected accounts
accounts = api.Me.codPoints() # returns data of type dict

# printing results to console
print(accounts)

User settings

Using the settings() method in sub class Me of API user's settings can be retrieved of the sso-token logged in with

from cod_api import API

# initiating the API class
api = API()

# loggin in with sso token
api.login('your_sso_token')

# retrieving user settings
settings = api.Me.settings() # returns data of type dict

# printing results to console
print(settings)