mlb_v3_playbyplay
v1.0.10
Published
MLB_play_by_play_API_
Downloads
4
Readme
mlb_v3_play_by_play
MlbV3PlayByPlay - JavaScript client for mlb_v3_play_by_play MLB play-by-play API. This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install mlb_v3_play_by_play --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/mlb_v3_play_by_play then install it via:
npm install YOUR_USERNAME/mlb_v3_play_by_play --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Getting Started
Please follow the installation instruction and execute the following JS code:
var MlbV3PlayByPlay = require('mlb_v3_play_by_play');
var defaultClient = MlbV3PlayByPlay.ApiClient.instance;
// Configure API key authorization: apiKeyQuery
var apiKeyQuery = defaultClient.authentications['apiKeyQuery'];
apiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyQuery.apiKeyPrefix['subscription-key'] = "Token"
// Configure API key authorization: apiKeyHeader
var apiKeyHeader = defaultClient.authentications['apiKeyHeader'];
apiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"
var api = new MlbV3PlayByPlay.DefaultApi()
var format = "format_example"; // {String} Desired response format. Valid entries are <code>XML</code> or <code>JSON</code>.
var gameid = "gameid_example"; // {String} The GameID of an MLB game. GameIDs can be found in the Games API. Valid entries are <code>14620</code> or <code>16905</code>
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.playByPlay(format, gameid, callback);
Documentation for API Endpoints
All URIs are relative to http://api.fantasydata.net/v3/mlb/pbp
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- MlbV3PlayByPlay.DefaultApi | playByPlay | GET /{format}/PlayByPlay/{gameid} | MlbV3PlayByPlay.DefaultApi | playByPlayDelta | GET /{format}/PlayByPlayDelta/{date}/{minutes} |
Documentation for Models
Documentation for Authorization
apiKeyHeader
- Type: API key
- API key parameter name: Ocp-Apim-Subscription-Key
- Location: HTTP header
apiKeyQuery
- Type: API key
- API key parameter name: subscription-key
- Location: URL query string