fflogsapi documentation
fflogsapi is a synchronous Python 3 client for FF Logs’ v2 API.
- Features:
Retrieve information from FF Logs’ v2 GraphQL API
Lazy evaluation to fetch the minimal required amount of information
Query caching to speed up repeat queries and reduce strain on the API
Looking for the GraphQL schema? See FF Logs’ official documentation.
Getting started
When you’re ready, follow the Getting started guide to start using fflogsapi. If you want to dive in head-first, have a look at the Example usage.
Contents
- Getting started
- Example usage
- User mode
- API reference
- Client
- Report API
- Reports
FFLogsReportFFLogsReport.abilities()FFLogsReport.actor()FFLogsReport.actors()FFLogsReport.archivation_data()FFLogsReport.codeFFLogsReport.duration()FFLogsReport.end_time()FFLogsReport.exported_segments()FFLogsReport.fight()FFLogsReport.fight_count()FFLogsReport.fights()FFLogsReport.guild()FFLogsReport.log_version()FFLogsReport.owner()FFLogsReport.ranked_characters()FFLogsReport.region()FFLogsReport.revision()FFLogsReport.segments()FFLogsReport.start_time()FFLogsReport.tag()FFLogsReport.title()FFLogsReport.visibility()FFLogsReport.zone()
- Fights
FFLogsFightFFLogsFight.bounding_box()FFLogsFight.complete_raid()FFLogsFight.difficulty()FFLogsFight.duration()FFLogsFight.encounter()FFLogsFight.end_time()FFLogsFight.enemy_npcs()FFLogsFight.events()FFLogsFight.fight_percentage()FFLogsFight.friendly_npcs()FFLogsFight.friendly_players()FFLogsFight.game_zone()FFLogsFight.graph()FFLogsFight.has_echo()FFLogsFight.idFFLogsFight.in_progress()FFLogsFight.is_kill()FFLogsFight.last_phase()FFLogsFight.last_phase_absolute()FFLogsFight.last_phase_intermission()FFLogsFight.maps()FFLogsFight.name()FFLogsFight.percentage()FFLogsFight.pets()FFLogsFight.phases()FFLogsFight.player_details()FFLogsFight.rankings()FFLogsFight.reportFFLogsFight.size()FFLogsFight.standard_comp()FFLogsFight.start_time()FFLogsFight.table()
- Reports
- Character API
- User API
- Guild API
FFLogsGuildFFLogsGuild.attendance()FFLogsGuild.characters()FFLogsGuild.competition_mode()FFLogsGuild.current_rank()FFLogsGuild.description()FFLogsGuild.grand_company()FFLogsGuild.idFFLogsGuild.name()FFLogsGuild.server()FFLogsGuild.stealth_mode()FFLogsGuild.tags()FFLogsGuild.type()FFLogsGuild.zone_rankings()
- World API
- Dataclasses
FFLogsAllStarsRankingFFLogsFightRankFFLogsFightRank.adpsFFLogsFightRank.best_jobFFLogsFightRank.bracket_dataFFLogsFightRank.fightFFLogsFightRank.guildFFLogsFightRank.historical_percentFFLogsFightRank.historical_total_parsesFFLogsFightRank.jobFFLogsFightRank.locked_inFFLogsFightRank.ndpsFFLogsFightRank.pdpsFFLogsFightRank.rank_percentFFLogsFightRank.rank_total_parsesFFLogsFightRank.rdpsFFLogsFightRank.today_percentFFLogsFightRank.today_total_parses
FFLogsEncounterRankingsFFLogsEncounterRankings.average_performanceFFLogsEncounterRankings.best_amountFFLogsEncounterRankings.difficultyFFLogsEncounterRankings.fastest_killFFLogsEncounterRankings.killsFFLogsEncounterRankings.median_performanceFFLogsEncounterRankings.metricFFLogsEncounterRankings.ranksFFLogsEncounterRankings.zone
FFLogsZoneEncounterRankingFFLogsZoneEncounterRanking.all_starsFFLogsZoneEncounterRanking.best_amountFFLogsZoneEncounterRanking.best_jobFFLogsZoneEncounterRanking.encounterFFLogsZoneEncounterRanking.fastest_killFFLogsZoneEncounterRanking.jobFFLogsZoneEncounterRanking.killsFFLogsZoneEncounterRanking.locked_inFFLogsZoneEncounterRanking.median_percentFFLogsZoneEncounterRanking.rank_percent
FFLogsZoneRankingFFLogsReportCharacterRankingFFLogsReportComboRankingFFLogsReportComboRanking.amountFFLogsReportComboRanking.best_rankFFLogsReportComboRanking.character_aFFLogsReportComboRanking.character_bFFLogsReportComboRanking.job_aFFLogsReportComboRanking.job_bFFLogsReportComboRanking.percentileFFLogsReportComboRanking.rankFFLogsReportComboRanking.total_parsesFFLogsReportComboRanking.type
FFLogsReportRankingFFAbilityFFItemFFJobFFGrandCompanyFFMapFFLogsReportTagFFLogsAttendanceReportFFLogsRankFFLogsGuildZoneRankingsFFLogsActorFFLogsReportAbilityFFLogsArchivalDataFFLogsPlayerDetailsFFLogsNPCDataFFGameZoneFFLogsPartitionFFLogsPhase
- Pagination