{"openapi":"3.1.0","info":{"title":"OpenCricket API","version":"0.1.0-preview","description":"Ball-by-ball cricket data. Pre-launch preview: the contract is published, keys open to the waitlist first."},"servers":[{"url":"https://opencricketapi.com","description":"Planned production"}],"paths":{"/v1/competitions":{"get":{"summary":"Leagues, ICC events and domestic competitions with seasons and match counts.","description":"Leagues, ICC events and domestic competitions with seasons and match counts. Plan: Starter.","parameters":[{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["Test","ODI","T20","One-day","Multi-day"]}},{"name":"gender","in":"query","required":false,"schema":{"type":"string","enum":["male","female"]}},{"name":"group","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/matches":{"get":{"summary":"Find matches by competition, season, team, venue, format or date range.","description":"Find matches by competition, season, team, venue, format or date range. Plan: Starter.","parameters":[{"name":"competition","in":"query","required":false,"schema":{"type":"string"}},{"name":"season","in":"query","required":false,"schema":{"type":"string"}},{"name":"team","in":"query","required":false,"schema":{"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["Test","ODI","T20","One-day","Multi-day"]}},{"name":"gender","in":"query","required":false,"schema":{"type":"string","enum":["male","female"]}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/matches/{id}":{"get":{"summary":"Match summary: teams, toss, result, venue, officials and innings totals.","description":"Match summary: teams, toss, result, venue, officials and innings totals. Plan: Starter.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/matches/{id}/scorecard":{"get":{"summary":"Full batting and bowling scorecard with dismissals and fall of wickets.","description":"Full batting and bowling scorecard with dismissals and fall of wickets. Plan: Starter.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/matches/{id}/deliveries":{"get":{"summary":"Every ball: batter, bowler, runs, extras, wickets and fielders.","description":"Every ball: batter, bowler, runs, extras, wickets and fielders. Plan: Developer.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"innings","in":"query","required":false,"schema":{"type":"string"}},{"name":"over_from","in":"query","required":false,"schema":{"type":"string"}},{"name":"over_to","in":"query","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/matches/{id}/overs":{"get":{"summary":"Over-by-over runs and wickets for Manhattan and worm charts.","description":"Over-by-over runs and wickets for Manhattan and worm charts. Plan: Developer.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/matches/{id}/partnerships":{"get":{"summary":"Partnership runs and balls for every wicket.","description":"Partnership runs and balls for every wicket. Plan: Developer.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/matches/{id}/phases":{"get":{"summary":"Powerplay, middle and death-over splits for limited-overs innings.","description":"Powerplay, middle and death-over splits for limited-overs innings. Plan: Developer.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/teams/{id}":{"get":{"summary":"Team profile with recent matches and competitions.","description":"Team profile with recent matches and competitions. Plan: Starter.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/players/{id}":{"get":{"summary":"Player profile with Cricsheet registry ID and career splits by format.","description":"Player profile with Cricsheet registry ID and career splits by format. Plan: Starter.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/players/{id}/matchups":{"get":{"summary":"Batter-versus-bowler history: balls, runs, dismissals, strike rate.","description":"Batter-versus-bowler history: balls, runs, dismissals, strike rate. Plan: Developer.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"opponent","in":"query","required":false,"schema":{"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["Test","ODI","T20","One-day","Multi-day"]}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/venues/{id}":{"get":{"summary":"Venue profile: matches hosted, average first-innings score, toss decisions.","description":"Venue profile: matches hosted, average first-innings score, toss decisions. Plan: Developer.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}},"/v1/search":{"get":{"summary":"Search players, teams, competitions and venues by name.","description":"Search players, teams, competitions and venues by name. Plan: Starter.","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plan restriction"},"404":{"description":"Not found or feature_not_available"},"429":{"description":"Quota exhausted"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Envelope":{"type":"object","properties":{"data":{},"meta":{"type":"object","properties":{"source":{"type":"string"},"licence":{"type":"string"},"source_url":{"type":"string"},"next_cursor":{"type":["string","null"]}}}}},"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}}}}