Skip to content
.NET Standard 2.0 wrapper around the SpeedRunsLive API
C# CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
SRLApiClient
Tests
docs
.editorconfig
.gitattributes
.gitignore
LICENSE
Readme.md
SRLApiClient.sln
azure-pipelines.yml
global.json

Readme.md

SRL API Client

NuGet NuGet Pre-Release Nuget Build Status GitHub license

This repository contains a compact, asynchronous .Net Standard 2.0 wrapper around the SpeedRunsLive API. The client is available via NuGet.

#.Net
dotnet add package SRLApiClient

#Package Manager
Install-Package SRLApiClient

Features

The client supports synchronous and asynchronous GET requests on the following endpoints:

  • Countries
  • Games
  • Leaderboards
  • Races
  • Past Races
  • Players
  • User

Authentication via HTTP is supported to update user profiles. POST/PUT requests on other endpoints are not possible, since users are missing the required privileges.

The client also supports a user defined number of HTTP clients. Requests are parallelized automatically. Using a pool size of > 10 is not recommended.


Requirements

The SRL API Client supports any platform that implements .NET Standard 2.0.

Dependencies

none


Usage

You can visit srlclient.zint.ch for the autogenerated API documentation.


License

SRLApiClient - A .NET Standard 2.0 wrapper around the SpeedRunsLive API
Copyright (C) 2018-2019  Matteias Collet

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
You can’t perform that action at this time.