# Real-Time NFL Scoreboard API (`fabri-lab/nfl-score-api`) Actor

Ultimate tool for developers, sports analysts, and betting enthusiasts who need fast, reliable, and detailed NFL data. Whether you're building a fan app, tracking live game situations, or analyzing team performance, this Actor delivers everything you need in a clean JSON format.

- **URL**: https://apify.com/fabri-lab/nfl-score-api.md
- **Developed by:** [Yusuf Barış](https://apify.com/fabri-lab) (community)
- **Categories:** Other, Automation
- **Stats:** 2 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## 🏈 Real-Time NFL Scoreboard 🚀

**The ultimate tool for live NFL scores, comprehensive stats, and odds!** ⚡

Welcome to the most **developer-friendly** and **reliable** NFL data extractor on the market. Whether you're building a fan app, a betting analyzer, or just love stats, this Actor delivers the touchdown you need! 🏆

---

### ✨ Features

*   🔴 **Live Updates:** Get scores, game clock, and periods in real-time.
*   📊 **Player Leaders:** See who is dominating via **Passing**, **Rushing**, and **Receiving** leaders for every game!
*   🔙 **Time Travel:** Easily fetch results from the **Previous Week** with one click.
*   🔍 **Team Filtering:** Filter the firehose and get only the games for your favorite team (e.g., `KC`, `SF`).
*   🧠 **Smart Data:** Detailed game situations like **Downs**, **Distance**, and **Possession** (who has the ball!).
*   💰 **Betting Odds:** Access the latest **Spreads**, **Over/Under**, and **Favorites**.
*   ⚡ **Blazing Fast:** Optimized for speed and low latency.

---

### 🛠️ Input Parameters

Customize your request easily! Just tell us what you need.

| Parameter | Type | What it does | Default |
| :--- | :---: | :--- | :--- |
| **`action`** | `enum` | `current`: Top shows this week's games. <br> `previous_week`: Automatically fetches last week's results. | `current` |
| **`team`** | `string` | Filter by team abbreviation (e.g., `BUF`, `DAL`). | *None* |
| **`year`** | `int` | The season year (e.g., `2024`) | *Current Season* |
| **`week`** | `int` | The week number (e.g., `5`) | *Current Week* |
| **`seasontype`** | `int` | `1`: Preseason, `2`: Regular, `3`: Postseason | `2` (Regular) |

#### 🧩 Input Example
Want to see how the **Kansas City Chiefs** did last week?

```json
{
    "action": "previous_week",
    "team": "KC"
}
````

***

### 📦 Output Data

You get a clean, structured JSON response with **rich statistical data**.

#### 💎 Output Example

```json
{
  "match_id": "401547403",
  "name": "Kansas City Chiefs vs Denver Broncos",
  "shortName": "KC vs DEN",
  "date": "2023-10-12T20:15:00Z",
  "status": {
    "type": "STATUS_IN_PROGRESS",
    "displayClock": "12:45",
    "detail": "2nd - 12:45"
  },
  "teams": {
    "home": {
      "name": "Kansas City Chiefs",
      "abbreviation": "KC",
      "score": 14,
      "leaders": [
        {
            "category": "Passing Leader",
            "name": "Patrick Mahomes",
            "value": "15/20, 200 YDS, 2 TD",
            "headshot": "https://a.espncdn.com/..."
        }
      ]
    },
    "away": { ... }
  },
  "game_situation": {
    "possession": "KC",
    "down": 3,
    "distance": 10,
    "redZone": true
  },
  "odds": {
    "favorite": "KC -10.5",
    "overUnder": 47.5
  }
}
```

***

### 🚀 Getting Started

1. **Deploy:** Click the "Run" button on Apify.
2. **Config:** Use the inputs to filter or travel back in time.
3. **Enjoy:** Consume the data via API or download it as JSON/CSV.

***

#### 📝 Notes

- *This actor is maintained for educational purposes.*
- *Data source is hidden for reliability.* 🤫

**Happy Coding!** 💻🏈

# Actor input Schema

## `action` (type: `string`):

Select 'current' for this week's games, 'previous\_week' for last week, or 'custom' to specify Year/Week manually.

## `team` (type: `string`):

Filter matches by team abbreviation (e.g. 'KC', 'DAL'). Case insensitive.

## `year` (type: `integer`):

The season year (e.g. 2024). Used only when Action is 'Custom'.

## `week` (type: `integer`):

The week number (e.g. 1-18). Used only when Action is 'Custom'.

## `seasontype` (type: `string`):

Select the season type.

## `proxyConfiguration` (type: `object`):

Select proxies to be used by your crawler.

## Actor input object example

```json
{
  "action": "custom",
  "team": "KC",
  "year": 2024,
  "week": 1,
  "seasontype": "2",
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "team": "KC",
    "year": 2024,
    "week": 1
};

// Run the Actor and wait for it to finish
const run = await client.actor("fabri-lab/nfl-score-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "team": "KC",
    "year": 2024,
    "week": 1,
}

# Run the Actor and wait for it to finish
run = client.actor("fabri-lab/nfl-score-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "team": "KC",
  "year": 2024,
  "week": 1
}' |
apify call fabri-lab/nfl-score-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=fabri-lab/nfl-score-api",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Real-Time NFL Scoreboard API",
        "description": "Ultimate tool for developers, sports analysts, and betting enthusiasts who need fast, reliable, and detailed NFL data. Whether you're building a fan app, tracking live game situations, or analyzing team performance, this Actor delivers everything you need in a clean JSON format.",
        "version": "0.0",
        "x-build-id": "hYxJF6l6BBwiNEBOQ"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/fabri-lab~nfl-score-api/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-fabri-lab-nfl-score-api",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/fabri-lab~nfl-score-api/runs": {
            "post": {
                "operationId": "runs-sync-fabri-lab-nfl-score-api",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/fabri-lab~nfl-score-api/run-sync": {
            "post": {
                "operationId": "run-sync-fabri-lab-nfl-score-api",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {
                    "action": {
                        "title": "Action Mode",
                        "enum": [
                            "current",
                            "previous_week",
                            "custom"
                        ],
                        "type": "string",
                        "description": "Select 'current' for this week's games, 'previous_week' for last week, or 'custom' to specify Year/Week manually.",
                        "default": "custom"
                    },
                    "team": {
                        "title": "Filter by Team (Optional)",
                        "type": "string",
                        "description": "Filter matches by team abbreviation (e.g. 'KC', 'DAL'). Case insensitive."
                    },
                    "year": {
                        "title": "Year (Optional)",
                        "type": "integer",
                        "description": "The season year (e.g. 2024). Used only when Action is 'Custom'.",
                        "default": 2024
                    },
                    "week": {
                        "title": "Week (Optional)",
                        "type": "integer",
                        "description": "The week number (e.g. 1-18). Used only when Action is 'Custom'.",
                        "default": 1
                    },
                    "seasontype": {
                        "title": "Season Type",
                        "enum": [
                            "1",
                            "2",
                            "3"
                        ],
                        "type": "string",
                        "description": "Select the season type.",
                        "default": "2"
                    },
                    "proxyConfiguration": {
                        "title": "Proxy Configuration",
                        "type": "object",
                        "description": "Select proxies to be used by your crawler.",
                        "default": {
                            "useApifyProxy": true
                        }
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
