API Docs

CricYug Developer API

Internal-first read-only API for CricYug verified cricket database. Public access should open only after data quality and licensing checks are complete.

Developer home

Authentication

Send Authorization: Bearer YOUR_KEY or x-api-key.

Read-only

Only GET is allowed. POST/PUT/PATCH/DELETE return 405.

Pagination

Use page and per_page. Max per_page is 100.

Database source

Historical external APIs are not used.

Endpoints

/api/v1/players/api/v1/teams/api/v1/matches/api/v1/series/api/v1/tournaments/api/v1/records/api/v1/search

Filters

`q` or `search`: text search
`format`: Test, ODI, T20, T20I, IPL
`team`: team name or slug text
`player`: player name or slug text
`year`: match/record year
`tournament`: series/tournament text
`venue`: venue text for matches
`include_unverified=true`: internal testing only

Example request

curl "https://cricyug.netlify.app/api/v1/matches?team=India&format=ODI&page=1&per_page=20" \
  -H "x-api-key: YOUR_CRICYUG_KEY"

Example response

{
  "data": [
    {
      "id": "uuid",
      "slug": "india-vs-australia-odi-final",
      "title": "India vs Australia",
      "format": "ODI",
      "verification_status": "verified"
    }
  ],
  "meta": {
    "resource": "matches",
    "source": "cricyug-db",
    "externalApiUsed": false,
    "internalOnly": true,
    "verifiedOnly": true,
    "page": 1,
    "perPage": 20,
    "returned": 1
  }
}

Internal access policy

CricYug Developer API is built for internal usage first. Public API access should remain closed until imported datasets are verified, licensed and ready for redistribution.