README.md

FFLogsAPI

A WIP FFLogs API implementation for .NET 5

Usage

Generate client:

var client = new FFLogsClient("FFLOGS_API_KEY");

You can generate your API key here.

Zones

// Get all zones
var zones = await client.GetZonesAsync();

// Get all Eden's Verse encounters
var encounter = zones.FirstOrDefault(x=>x.Name = "Eden's Verse")?.Encounters;

// Get Ramuh encounter ID
var ramuhId = zones.FirstOrDefault(x=>x.Name = "Eden's Verse")?.Encounters
  .FirstOrDefault(x=>x.Name = "Ramuh")?.Id;

Jobs

// Get all jobs
var jobs = await client.GetJobsAsync();

// Get Black Mage job Id
var blmId = jobs.FirstOrDefault(x=> x.Name == "Black Mage")?.Id;

// Get job name of the job with Id: 8
var jobName = jobs.FirstOrDefault(x=> x.Id == 8)?.Name; // Returns Ninja

Rankings

Encounter rankings

// Get Ramuh encounter ID
var zones = await client.GetZonesAsync();
var ramuhId = zones.FirstOrDefault(x=>x.Name = "Eden's Verse")?.Encounters
  .FirstOrDefault(x=>x.Name = "Ramuh")?.Id;
  
// Get all rankings from that fight
var encounterRankings = await client.GetEncounterRankingsAsync(ramuhId);

Character rankings

// Get all rankings from a specific character
var characterRankings = await client.GetCharacterRankingsAsync("Ame Aghalair", Server.Europe.Chaos.Ragnarok);

Parses

// Get all parses from a specific character
var characterParses = await client.GetCharacterParsesAsync("Ame Aghalair", Server.Europe.Chaos.Ragnarok);

Reports

Guild reports

// Get all reports from a specific guild
var guildReports = await client.GetGuildReportsAsync("EXPLOSION MAGIC", Server.Europe.Chaos.Cerberus);

User reports

// Get all reports from a specific user on FFLogs
var userReports = await client.GetUserReportsAsync("userName");