Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/karthikgangadhar/ape-cricket
This is a live cricket api provides data using crickapi.com
https://github.com/karthikgangadhar/ape-cricket
ape-cricket cricket cricket-data fantasy-league nodejs npm-module npm-package player-stats schedule
Last synced: 15 days ago
JSON representation
This is a live cricket api provides data using crickapi.com
- Host: GitHub
- URL: https://github.com/karthikgangadhar/ape-cricket
- Owner: KarthikGangadhar
- License: mit
- Created: 2017-10-14T22:21:55.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-31T18:45:47.000Z (about 5 years ago)
- Last Synced: 2024-10-19T09:53:13.907Z (19 days ago)
- Topics: ape-cricket, cricket, cricket-data, fantasy-league, nodejs, npm-module, npm-package, player-stats, schedule
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ape-cricket
- Size: 34.2 KB
- Stars: 6
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ape-cricket
[](https://nodei.co/npm/ape-cricket/)
The [ape-cricket](http://apecricket.herokuapp.com/documentation#) is a rest-api exported as Node.js module.
[](https://travis-ci.org/KarthikGangadhar/ape-cricket)
[](http://apecricket.herokuapp.com/documentation#)
[](http://nodejs.org/download/)
[](https://snyk.io/test/github/KarthikGangadhar/ape-cricket?targetFile=package.json)
## Description
The ape-cricket uses [cricapi](http://www.cricapi.com/), Free to use, super-high bandwidth, high performance Cricket API. Targeted at Developers and Cricket lovers.
The endpoints exposed are as follows:
* `apecricket.schedule( )` provides international fixtures
* `apecricket.cricket( )` provides live scrores of ongoing match
* `apecricket.news( )` provides updated cricket news
* `apecricket.upcomingMatches( )` provides upcoming match fixtures
* `apecricket.cricketScore( )` provides detailed score card of the match
* `apecricket.playerStats( )` provides players carrer info and stats
* `apecricket.playerFinder( )` provides players ids matching given name string
* `apecricket.fantasySummary( )` provides match info and stats
* `apecricket.fantasySquad( )` provides team players info
In order to use the above endpoints, u need to have an api_key which can use generated by signing into [cricpapi](http://www.cricapi.com). For testing purpose can use test_api_key `"TESTKEY0273"`
## Installation
Installation is done using the npm install command:
```js
$ npm install ape-cricket
```
#### In Node.js:
```js
// Load the full build.
var apecricket = require("ape-cricket");
```
#### schedule
```js
//user api_key
var api_key = "TESTKEY0273"
// calling a endpoint to get response.
apecricket.schedule( api_key, function(response){
// response will be json data of upcoming cricket matches
});
```
#### cricket
```js
//user api_key
var api_key = "TESTKEY0273"
// calling a endpoint to get response.
apecricket.cricket( api_key, function(response){
// response will be json data of upcoming cricket matches
});
```
#### news
```js
//user api_key
var api_key = "TESTKEY0273"
// calling a endpoint to get response.
apecricket.news( api_key, function(response){
// response will be json data of upcoming cricket matches
});
```
#### upcomingMatches
```js
//user api_key
var api_key = "TESTKEY0273"
// calling a endpoint to get response.
apecricket.upcomingMatches( api_key, function(response){
// response will be json data of upcoming cricket matches
});
```
The endpoints `cricketScore()` and `playerStats()` require a string input field `"unique_id"` and `"pid"(player_id)`. `"unique_id"` for each match is available from the `cricket()` endpoint response. and for `"pid"(player_id)` need to visit [cricapi players page](http://www.cricapi.com/players/). usage is as follows:
#### cricketScore
```js
//user api_key
var api_key = "TESTKEY0273"
//match id
var unique_id = "1123492"
// calling a endpoint to get response.
apecricket.cricketScore( api_key, unique_id , function(response){
// response will be json data of mentioned unique_id
});
```
#### playerStats
```js
//user api_key
var api_key = "TESTKEY0273"
// player id
var pid = 35320;
// calling a endpoint to get response.
apecricket.playerStats( api_key, pid , function(response){
// response will be json data of mentioned player
});
```
#### playerfinder
```js
//user api_key
var api_key = "TESTKEY0273"
// player id
var name = "sach";
// calling a endpoint to get response.
apecricket.playerFinder( api_key, name , function(response){
// response will be json data of matching player ids
});
```
#### Fantasy API are billable since they're designed to help you generate income by running Fantasy Cricket portals. ####
Each hit is 1 credit. You get 250 credits free. Deducted from your prepaid account.
#### fantasySummary
```js
//match id
var unique_id = "1123492"
// calling a endpoint to get response.
apecricket.fantasySummary(api_key, unique_id, function (response) {
// response will be json data of mentioned unique_id
console.log(response);
});
```
#### fantasySquad
```js
//match id
var unique_id = "1123492"
// calling a endpoint to get response.
apecricket.fantasySquad(api_key, unique_id, function (response) {
// response will be json data of mentioned unique_id
console.log(response);
});
```