Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luisramirezdev/capi-docs
Documentation for https://github.com/lierrmm/node-callofduty
https://github.com/luisramirezdev/capi-docs
Last synced: 30 days ago
JSON representation
Documentation for https://github.com/lierrmm/node-callofduty
- Host: GitHub
- URL: https://github.com/luisramirezdev/capi-docs
- Owner: luisramirezdev
- Created: 2020-09-08T12:49:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-01T06:45:43.000Z (about 4 years ago)
- Last Synced: 2024-08-03T22:18:30.847Z (4 months ago)
- Language: CSS
- Size: 454 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - luisramirezdev/capi-docs - Documentation for https://github.com/lierrmm/node-callofduty (CSS)
README
# Install
```sh
npm install call-of-duty-api
```
# Usage
```js
const API = require('call-of-duty-api')();
```
or
```js
const API = require('call-of-duty-api')({ platform: "battle" });
```
# Platforms
- psn
- steam
- xbl
- battle
- acti
- uno ( numerical identifier )
# Login :id=login
!> Login is required to remove any restrictions on certain endpoints.
```js
try {
await API.login(, );
} catch(Error) {
//Handle Exception
}
```
# Modern Warfare
## - Leaderboards :id=leaderboards
Example
```js
try {
let data = await API.MWLeaderboard(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/MWLeaderboard.json ':include :type=code')
## - MP Match Details :id=mp-match-details
Example
```js
try {
let data = await API.MWcombatmp(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/MWcombatmp.json ':include :type=code')
## - WZ Match Details :id=wz-match-details
Example
```js
try {
let data = await API.MWcombatwz(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/MWcombatwz.json ':include :type=code')
## - MP Details :id=mp-details
Example
```js
try {
let data = await API.MWmp(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/MWmp.json ':include :type=code')
## - WZ Details :id=wz-details
Example
```js
try {
let data = await API.MWwz(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/MWwz.json ':include :type=code')
## - Battle Royale Information :id=br-info
Example
```js
try {
let data = await API.MWBattleData(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/MWBattleData.json ':include :type=code')
## - Weekly Stats :id=weekly-stats
Example
```js
try {
let data = await API.MWweeklystats(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/MWweeklystats.json ':include :type=code')
## - Loot :id=mw-loot
Example
```js
try {
let data = await API.MWloot(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/MWloot.json ':include :type=code')
## - Analysis :id=mw-analysis
Example
```js
try {
let data = await API.MWAnalysis(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/MWAnalysis.json ':include :type=code')
## - Map List :id=map-list
Example
```js
try {
let data = await API.MWMapList();
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/MWMapList.json ':include :type=code')
## - Get Battle Pass :id=battle-pass-loot
Example
```js
try {
let data = await API.getBattlePassLoot(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/getBattlePassLoot.json ':include :type=code')
## - Fuzzy Search :id=fuzzy-search
!> To search all platforms, pass in 'all'
Example
```js
try {
let data = await API.FuzzySearch(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/FuzzySearch.json ':include :type=code')
## - Get Store Loot :id=store-loot
Example
```js
try {
let data = await API.getPurchasable(?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/getPurchasable.json ':include :type=code')
## - Get Cod Points :id=cod-points
!> Logged in user only
Example
```js
try {
let data = await API.getCodPoints(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/getCodPoints.json ':include :type=code')
## - Logged In User Info :id=user-info
!> Logged in user only
Example
```js
try {
let data = await API.getLoggedInUserInfo();
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/getLoggedInUserInfo.json ':include :type=code')
## - Connected Accounts :id=connected-accounts
!> Logged in user only
Example
```js
try {
let data = await API.ConnectedAccounts(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/ConnectedAccounts.json ':include :type=code')
## - Event Feed :id=event-feed
!> Logged in user only
Example
```js
try {
let data = await API.getEventFeed();
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/getEventFeed.json ':include :type=code')
## - Logged In Identities :id=identities
!> Logged in user only
Example
```js
try {
let data = await API.getLoggedInIdentities();
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/getLoggedInIdentities.json ':include :type=code')
## - Account Settings :id=settings
!> Logged in user only
Example
```js
try {
let data = await API.Settings(, ?);
} catch(Error) {
//Handle Exception
}
```
Response
[filename](_json/Settings.json ':include :type=code')