Cfbd NPM | npm.io

cfbd

This API is in limited Beta for Patreon subscribers. It may have bugs and is subject to changes. API keys can be acquired from the CollegeFootballData.com website.

This TypeScript package is automatically generated by the Hey API project:

API version: 5.0.10
Package version: 5.0.10-alpha.0

Requirements.

Node 18+

Installation

npm install

npm install cfbd

yarn install

yarn add cfbd

pnpm install

pnpm add cfbd

Usage

Authorization

To authorize requests, use the setConfig method to set the Authorization header using your personal API key. API keys can be acquired from the CollegeFootballData.com website.

import { client } from 'cfbd';

client.setConfig({
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
    }
});

Example Usage

All API operations can be imported from the cfbd package and used as shown below.

import { client, getGames } from 'cfbd';

// Set up the client with your API key
client.setConfig({
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
    }
});

// Call the getGames endpoint
const games = await getGames({
    query: {
        year: 2023,
        classification: 'fbs',
    },
});

for (const game of games.data ?? []) {
    // Do something with the game data
    // For example:
    console.log(`${game.awayTeam} vs ${game.homeTeam} - ${game.excitementIndex}`);
}