nfl_v3_play_by_play

NflV3PlayByPlay - JavaScript client for nfl_v3_play_by_play NFL 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 nfl_v3_play_by_play --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/nfl_v3_play_by_play then install it via:

    npm install YOUR_USERNAME/nfl_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 NflV3PlayByPlay = require('nfl_v3_play_by_play');

var defaultClient = NflV3PlayByPlay.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 NflV3PlayByPlay.DefaultApi()

var format = "format_example"; // {String} Desired response format. Valid entries are <code>XML</code> or <code>JSON</code>.

var season = "season_example"; // {String}  Year of the season and the season type. If no season type is provided, then the default is regular season. <br>Examples: <code>2015REG</code>, <code>2015PRE</code>, <code>2015POST</code>.

var week = "week_example"; // {String}  Week of the season. Valid values are as follows: Preseason 0 to 4, Regular Season 1 to 17, Postseason 1 to 4. Example: <code>1</code>

var hometeam = "hometeam_example"; // {String} Abbreviation of the home team. Example: <code>WAS</code>.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.playByPlay(format, season, week, hometeam, callback);

Documentation for API Endpoints

All URIs are relative to http://api.fantasydata.net/v3/nfl/pbp

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- NflV3PlayByPlay.DefaultApi | playByPlay | GET /{format}/PlayByPlay/{season}/{week}/{hometeam} | NflV3PlayByPlay.DefaultApi | playByPlayDelta | GET /{format}/PlayByPlayDelta/{season}/{week}/{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