← Gridiron Intelligence Hub | API Help Page | Interactive Swagger UI ↗ | OpenAPI 3.0 Spec (JSON)
⚡ Environments, Base URLs, Caching & Authentication Reference ▲ Collapse
Primary API Base URL (Azure Functions)
https://nfl-giambattista-func.azurewebsites.net
Direct HTTPS Python v2 Function App • CORS: * • Gzip enabled
Container App Proxy & Static Web App
https://nfl-container.giambattista.io/api/*
https://nfl.giambattista.io
Local Docker Container
http://localhost:8080/api/*
Nginx proxies /api/* straight to Azure Functions
Authentication & Cache Bypass
Read APIs: Anonymous (No Key)
Sync API (/api/sync-nfl): x-functions-key header
Bypass cache on any GET: append ?refresh=1

API Help Page & Postman Generator Guide

Keyboard Shortcuts

/ Focus endpoint search  •  Esc Clear search / close modal

Endpoint Badges

ANON Public endpoint — callable directly from browsers, curl, Python, or Postman with no API key.

FUNC_KEY Protected write endpoint — supply x-functions-key header or ?code= query parameter.

INPUT Accepts path parameters, query string filters, or JSON request body.

GZIP Automatically compresses JSON payloads > 2 KB by ~85% when Accept-Encoding: gzip is sent.

CACHED Cached in worker memory (30–120s TTL) to protect SQL DTUs; pass ?refresh=1 for a guaranteed live SQL read.

Postman & Newman CLI Usage

Click Collection and Environment in the header to download ready-to-import Postman v2.1 JSON files. Run automated CI checks via Newman:

newman run NFL_Gridiron_API.postman_collection.json -e NFL_Gridiron_API.postman_environment.json