Skip to content

Commit

Permalink
expand doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ate47 committed Oct 13, 2023
1 parent 11c059d commit 6bba07e
Show file tree
Hide file tree
Showing 12 changed files with 810 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
This is an unofficial API URI list. Copy of my [COD](https://github.com/ate47/COD) repository doc.

# COD API

**Table of content**

- [API](apicall.md)
- [Maps](maps.md)
- [CDN and items](cdn.md)
- [API Connection](connect.md)
- [Cod points](cp.md)
- [Profile information](profile_info.md)
- [Profile stats](profile_stats.md)
- Friends (WIP)
- Account search (WIP)
- MTX (WIP)
63 changes: 63 additions & 0 deletions docs/api/apicall.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
title,url
fetchFriendsByIdentity,"https://my.callofduty.com/api/papi-client/codfriends/v1/{{platform}}/gamer/{{username}}/compendium"
fetchFavoriteFriends,"https://my.callofduty.com/api/papi-client/relationships/v1/list"
sendAddFavoriteFriend,"https://my.callofduty.com/api/papi-client/relationships/v1/friend/platform/{{platform}}/gamer/{{username}}/set/fav"
sendRemoveFavoriteFriend,"https://my.callofduty.com/api/papi-client/relationships/v1/friend/platform/{{platform}}/gamer/{{username}}/set/delete"
sendFriendRequestByPlatform,"https://my.callofduty.com/api/papi-client/codfriends/v1/invite/{{platform}}/gamer/{{username}}"
sendFriendRequestByUno,"https://my.callofduty.com/api/papi-client/codfriends/v1/invite/uno/id/{{unoId}}"
sendCancelFriendRequest,"https://my.callofduty.com/api/papi-client/codfriends/v1/uninvite/uno/id/{{unoId}}"
sendAcceptFriendRequest,"https://my.callofduty.com/api/papi-client/codfriends/v1/invite/uno/id/{{unoId}}"
sendRejectFriendRequest,"https://my.callofduty.com/api/papi-client/codfriends/v1/reject/uno/id/{{unoId}}"
sendBlockFriend,"https://my.callofduty.com/api/papi-client/codfriends/v1/block/uno/id/{{unoId}}"
sendUnblockFriend,"https://my.callofduty.com/api/papi-client/codfriends/v1/unblock/uno/id/{{unoId}}"
sendRemoveFriend,"https://my.callofduty.com/api/papi-client/codfriends/v1/remove/uno/id/{{unoId}}"
fetchChallengeToken,"https://my.callofduty.com/api/papi-client/gifting/v2/proof/{{unoId}}/{{otp}}"
fetchGiftableFriends,"https://my.callofduty.com/api/papi-client/gifting/v2/title/{{title}}/platform/{{platform}}/uno/{{unoId}}/sku/{{sku}}/giftableFriends"
sendFriendGift,"https://my.callofduty.com/api/papi-client/gifting/v2/title/{{title}}/platform/{{platform}}/gamer/{{username}}"
fetchPlayerLootstreams,"https://my.callofduty.com/api/papi-client/loot/title/{{title}}/platform/{{platform}}/gamer/{{username}}/status/{{locale}}"
fetchSeasonLootstream,"https://my.callofduty.com/api/papi-client/loot/title/{{title}}/platform/{{platform}}/list/{{list}}/{{locale}}"
fetchCODPointsByPlatform,"https://my.callofduty.com/api/papi-client/inventory/v1/title/{{title}}/platform/{{platform}}/gamer/{{username}}/currency"
fetchPurchasableItems,"https://my.callofduty.com/api/papi-client/inventory/v1/title/{{title}}/platform/{{platform}}/purchasable/gamer/{{username}}/{{locale}}"
fetchPurchasableItemBySku,"https://my.callofduty.com/api/papi-client/inventory/v1/title/{{title}}/bundle/{{sku}}/{{locale}}"
sendInventoryPurchase,"https://my.callofduty.com/api/papi-client/inventory/v1/title/{{title}}/platform/{{platform}}/gamer/{{username}}/item/{{item}}/purchaseWith/CODPoints"
fetchUserLeaderboard,"https://my.callofduty.com/api/papi-client/leaderboards/v2/title/{{title}}/platform/{{platform}}/time/{{timeframe}}/type/{{type}}/mode/{{mode}}/gamer/{{username}}"
fetchFriendsLeaderboard,"https://my.callofduty.com/api/papi-client/leaderboards/v2/title/{{title}}/platform/{{platform}}/time/{{timeframe}}/type/{{type}}/mode/{{mode}}/gamer/{{username}}/friends"
fetchPageLeaderboard,"https://my.callofduty.com/api/papi-client/leaderboards/v2/title/{{title}}/platform/{{platform}}/time/{{timeframe}}/type/{{type}}/mode/{{mode}}/page/{{page}}"
fetchLoadoutArsenal,"https://my.callofduty.com/api/papi-client/loadouts/v4/title/{{title}}/items/mode/mp/{{locale}}"
fetchLoadouts,"https://my.callofduty.com/api/papi-client/loadouts/v3/title/{{title}}/platform/{{platform}}/gamer/{{username}}/mode/mp"
sendLoadouts,"https://my.callofduty.com/api/papi-client/loadouts/v3/title/{{title}}/platform/{{platform}}/gamer/{{username}}/mode/mp/slot/{{slot}}"
fetchPreferencesList,"https://my.callofduty.com/api/papi-client/preferences/v1/platform/{{platform}}/gamer/{{username}}/list"
sendPreference,"https://my.callofduty.com/api/papi-client/preferences/v1/platform/{{platform}}/gamer/{{username}}/preference/{{preference}}/set/{{set_id}}"
sendUnoPreference,"https://my.callofduty.com/api/papi-client/preferences/v1/platform/uno/id/{{unoId}}/preference/{{preference}}/set/{{value}}"
fetchSquad,"https://squads.callofduty.com/api/v2/squad/lookup/mine"
fetchSquadObjectByName,"https://squads.callofduty.com/api/v2/squad/search?name={{name}}"
fetchSquadObjectByIdentity,"https://my.callofduty.com/api/v2/squad/lookup/platform/{{platform}}?gamerTag={{username}}"
sendSquadCreate,"https://squads.callofduty.com/api/v2/squad/create"
sendSquadEdit,"https://squads.callofduty.com/api/v2/squad/update"
fetchSquadJoin,"https://squads.callofduty.com/api/v2/squad/join?name={{name}}"
fetchSquadLeave,"https://squads.callofduty.com/api/v2/squad/leave"
sendSquadRemoveMember,"https://squads.callofduty.com/api/v2/squad/removeMembers"
fetchSquadReport,"https://squads.callofduty.com/api/v2/squad/report/{{name}}"
sendUserFeedback,"https://squads.callofduty.com/api/v2/user/feedback"
fetchChallengeTournament,"https://squads.callofduty.com/api/v2/challenge/lookup/current"
fetchChallengeHistory,"https://squads.callofduty.com/api/v2/challenge/history/page/{{page}}"
fetchRewards,"https://squads.callofduty.com/api/v2/rewards/lookup/current"
fetchClaimRewards,"https://squads.callofduty.com/api/v2/rewards/claim"
fetchPlayerStatsByMode,"https://my.callofduty.com/api/papi-client/stats/cod/v1/title/{{title}}/platform/{{platform}}/gamer/{{username}}/profile/type/{{gameMode}}"
fetchPlayerStatsByModeAndPeriod,"https://my.callofduty.com/api/papi-client/stats/cod/v1/title/{{title}}/platform/{{platform}}/gamer/{{username}}/profile/type/{{gameMode}}?periods={{periods}}&locale={{locale}}"
fetchPlayerFriendStatsByMode,"https://my.callofduty.com/api/papi-client/stats/cod/v1/title/{{title}}/platform/{{platform}}/gamer/{{username}}/profile/friends/type/{{gameMode}}"
fetchPlayerRecentMatchesByMode,"https://my.callofduty.com/api/papi-client/crm/cod/v2/title/{{title}}/platform/{{platform}}/gamer/{{username}}/matches/{{gameMode}}/start/0/end/0/details?locale={{locale}}"
fetchPlayerFullMatchById, "https://my.callofduty.com/api/papi-client/crm/cod/v2/title/{{title}}/platform/{{platform}}/fullMatch/{{gameMode}}/{{matchId}}/{{locale}}"
fetchPlayerCommunityMap,"https://my.callofduty.com/api/papi-client/ce/v1/title/{{title}}/platform/{{platform}}/gameType/{{gameMode}}/communityMapData/availability"
fetchUserTitleIdentities,"https://my.callofduty.com/api/papi-client/crm/cod/v2/identities"
fetchUserTitleIdentitiesByUno,"https://my.callofduty.com/api/papi-client/crm/cod/v2/identities/platform/uno/id/{{unoId}}"
fetchUserAccounts,"https://my.callofduty.com/api/papi-client/crm/cod/v2/accounts"
fetchUserAccountsByIdentity,"https://my.callofduty.com/api/papi-client/crm/cod/v2/accounts/platform/{{platform}}/gamer/{{username}}"
fetchUserAvatarByIdentity,"https://my.callofduty.com/api/papi-client/crm/cod/v2/platform/{{platform}}/gamer/{{username}}/avatar"
fetchUserAvatarByUno,"https://my.callofduty.com/api/papi-client/crm/cod/v2/platform/{{platform}}/uno/{{unoId}}/avatar"
fetchUserFriendFeed,"https://my.callofduty.com/api/papi-client/userfeed/v1/friendFeed/rendered/{{locale}}"
sendUserFriendFeedEntry,"https://my.callofduty.com/api/papi-client/userfeed/v1/friendFeed/details/{{locale}}"
sendUserFriendFeedReaction,"https://my.callofduty.com/api/papi-client/userfeed/v1/reactions/set/{{reaction}}/{{locale}}"
fetchUserFeedAchievements,"https://my.callofduty.com/api/papi-client/userfeed/v1/friendFeed/platform/{{platform}}/gamer/{{username}}/friendFeedEvents/{{locale}}"
sendUserFeedPinStatus,"https://my.callofduty.com/api/papi-client/userfeed/v1/favorite/set/{{slot}}/{{locale}}"
fetchUserSearchByIdentity,"https://my.callofduty.com/api/papi-client/crm/cod/v2/platform/{{platform}}/username/{{username}}/search"
151 changes: 151 additions & 0 deletions docs/api/apicall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
[...home](README.md)

- [API calls](#api-calls)
- [Parameters](#parameters)
- [platform](#platform)
- [title](#title)
- [username](#username)
- [unoId](#unoid)
- [locale](#locale)
- [item](#item)
- [slot](#slot)
- [preference](#preference)
- [gameMode](#gamemode)


# API calls

You can find the extracted URLs from the COD companion app in the [apicall.csv](apicall.csv) file.

## Parameters

In the API calls, you can find different parameters.

### platform

Platform of the user

**Value**:

- `xbl`: Xbox Live
- `battle`: Battle net
- `psn`: PlayStation Network
- `steam`: Steam
- `uno`: Activision

### title

Game title

**Value**:

- `bo3`: Call of Duty: Black Ops 3
- `bo4`: Call of Duty: Black Ops 4
- `cw`: Call of Duty: Black Ops Cold War
- `vg`: Call of Duty: Vanguards
- `mw`: Call of Duty: Modern Warfare 2019
- `mw2`: Call of Duty: Modern Warfare 2022
- `iw`: Call of Duty: Infinite Warfare
- `ww2`: Call of Duty: World War 2


### username

Username/identifier of the user

**Value**: Your username, with the `#` for uno/battle

### unoId

Uno ID of an user

**Value**: Uno ID

### locale

The asked locale, aka the language/dialect

**Value**: example: `en` for English, `fr` for French, etc.

### item

Show item

**Value**: item

### slot

Loadout slot id

**Value**: slot id

### preference

Loadout preference id

**Value**: preference id

### gameMode

Depends on the previous path parameter

- type (Multiplayer/BR/Zombies)
- gameType (TDM,FFA,etc.), if it is asked for a gameType,

**Value**: Gamemodes

- `mp`: Multiplayer
- `wz`: Blackout(BO4)/Warzone(MW19/22)/Fireteam(CW) (Blackout/fireteam's internal name is Warzone)
- `zm`: Zombies


**Value**: Gametypes

*This list can be long, here are the gamemode for BO4 as an example: hc = Hardcore, cwl = Cod World League*

- `conf`: Kill confirm
- `conf_hc`: Kill confirm HC
- `ctf`: Capture the flag
- `dm`: Demolition
- `dm_hc`: Demolition HC
- `dom`: Domination
- `dom_hc`: Domination HC
- `dom_snipe_bb`: Domination Sniper only
- `dom_bb`: Domination long
- `dom_bb_hc`: Domination long HC
- `dom_dm`: Domination deathmatch
- `gun`: Gun game
- `gun_hc`: Gun game HC
- `koth`: Hardpoint
- `koth_bb`: Hardpoint long
- `koth_cwl`: Hardpoint CWL
- `infect`: Infected
- `infect_hc`: Infected HC
- `prop`: Prophunt
- `prop_hc`: Prophunt HC
- `sd`: Search and destroy
- `sd_bb`: Search and destroy ???
- `sd_hc`: Search and destroy HC
- `sd_cwl`: Search and destroy CWL
- `tdm`: Team deathmatch
- `tdm_hc`: Team deathmatch HC
- `tdm_bb`: Team deathmatch long
- `tdm_bb_hc`: Team deathmatch long HC
- `tdm_snipe_bb`: Team deathmatch Sniper only
- `control`: Control
- `control_hc`: Control HC
- `control_cwl`: Control CWL
- `bounty`: ???
- `bounty_hc`: ??? HC
- `escort`: Escort
- `escort_hc`: Escort HC
- `oic`: ???
- `clean`: ???
- `sas`: Stick and stones
- `sas_hc`: Stick and stones HC
- `warzone_solo`: Blackout solo
- `warzone_duo`: Blackout duo
- `warzone_quad`: Blackout quad
- `warzone_escape_duo_dbno`: Blackout alcatraz duo
- `warzone_escape_quad_dbno`: Blackout alcatraz quad
- `warzone_hot_pursuit`: Blackout hot pursuit
Loading

0 comments on commit 6bba07e

Please sign in to comment.