Giter Club home page Giter Club logo

thefinals.net's Introduction

TheFinals.NET

TheFinals.NET is a .NET wrapper for The Finals API. This library provides a simple and efficient way to interact with the API, allowing you to retrieve for eaxmple leaderboard data with ease.

Features

  • Supports multiple versions/seasons of the leaderboard API.
  • Simple api to get leaderboard data.
  • Allows filtering of leaderboard entries by name.
  • Supports retrieving a specific number of leaderboard entries.
  • Supports retrieving League image for each league, as url or byte array.
  • Supports retrieving some of the images, like embark logo, steam, psn and xbox.
  • Supports event leaderboards, with PlatformPushEvent for now.

Installation

NuGet version (TheFinals.NET)

Usage

Here's a basic example of how to use TheFinals.NET:

using TheFinals.NET.Endpoints;
using TheFinals.NET.Enums;
using TheFinals.NET.Models;
using TheFinals.NET.Providers;

TheFinalsClient client = new TheFinalsClient();
List<LeaderboardEntry> leaderboardSeason2 = await client.Leaderboards.Main.GetAsync(LeaderboardVersion.Season2);
List<LeaderboardEntry> leaderboardSeason1Filters = await client.Leaderboards.Main.GetAsync(LeaderboardVersion.Season1, Platform.Steam, count:500, nameFilter:"asd");

string imageUrl = client.League.GetImageUrl(leaderboardSeason2[0].League, LeagueImageType.Full);
byte[] imageByte = await client.League.GetImageAsync(League.Diamond4, LeagueImageType.Thumbnail); 

LeaderboardEntry includes League property, and can be used to get an League Image for example.

Endpoints:

TheFinalsClient
	Leaderboards
		Main
			List<LeaderboardEntry> GetAsync(LeaderboardVersion, Platform = Platform.Crossplay, int? = null, string = null)
		PlatformPushEvent
			PlatformPushEventLeaderboard GetAsync(int? = null, string = null)
TheFinalsClient
	League
		string GetImageUrl(League, LeagueImageType)
		byte[] GetImageAsync(League, LeagueImageType)
TheFinalsClient
	Image
		string GetUrl(EmbarkImage)
		byte[] GetAsync(EmbarkImage)

Contributing

Contributions are always welcomed.

Note

Project is not affiliated with Embark Studios or The Finals.

Links

Official The Finals Leaderboard

thefinals.net's People

Contributors

mcunderground avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.