Skip to content

acgfbr/rivalry-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Available endpoints

Method Endpoint Usage Returns
GET /v1/games Get several games games
GET /v1/games/{id} Get a game game
GET /v1/matches Get several matches matches
GET /v1/matches/{id} Get a match match
GET /v1/tournaments Get several tournaments tournaments
GET /v1/tournaments/{id} Get a tournament tournament
GET /v1/affiliates/stats Get affiliate's report affiliate report
GET /v1/affiliates/codes Get affiliate's subcodes affiliate subcodes

Requests

The Rivalry.com API is based on REST principles. Data resources are retrieved via standard HTTPS GET requests in UTF-8 format to an API endpoint.

The API rate limit is currently 60 requests/minute.

Responses

Rivalry.com API returns all successful response data as a JSON object with HTTP status code 200.

The requested data is always wrapped in a data field:

{
	"data": {

	}
}

Timestamps

Timestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.

Pagination

Some endpoints return a paginated result set, taking page as a parameter: https://www.rivalry.com/api/v1/games?page=1

When the results are paginated, pagination data will be added to the resource:

{
	"links": {
		"first": "https://www.rivalry.com/api/v1/games?page=1",
		"last": "https://www.rivalry.com/api/v1/games?page=1",
		"prev": null,
		"next": null
	},
	"meta": {
		"current_page": 1,
		"from": 1,
		"last_page": 1,
		"path": "https://www.rivalry.com/api/v1/games",
		"per_page": 15,
		"to": 7,
		"total": 7
	}
}

About

API Documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published