# Joe's Blue Archive Tools API

> Programmatic access to Blue Archive game data and your user data on Joe's Blue Archive Tools.

The public API of [Joe's Blue Archive Tools](https://ba.joexyz.online): Blue Archive game data, content that players share, and your own data on the site.

## Variables (Production)

| Name | Value |
| --- | --- |
| `base_url` | `https://ba.joexyz.online` |
| `api_key` | `<redacted>` |

## Endpoints

- [Game data](https://ba.joexyz.online/developers/reference/game-data.md): Static Blue Archive game data.
  - [List students](https://ba.joexyz.online/developers/reference/game-data/list-students.md): Lists playable students in the default roster order.
  - [Get a student](https://ba.joexyz.online/developers/reference/game-data/get-a-student.md): Gets a student's full profile: names in every language, combat data, stats, availability per server, gift preferences and variants.
  - [Get a student's skills](https://ba.joexyz.online/developers/reference/game-data/get-a-students-skills.md): Gets a student's skills with per-level descriptions, plus the buffs and debuffs (effects) that the descriptions refer to by id.
  - [List gifts](https://ba.joexyz.online/developers/reference/game-data/list-gifts.md): Lists gifts by id, with the students who adore, love or like each one.
  - [Get a gift](https://ba.joexyz.online/developers/reference/game-data/get-a-gift.md): Gets one gift, including its descriptions.
  - [List upcoming Global banners](https://ba.joexyz.online/developers/reference/game-data/list-upcoming-global-banners.md): Lists upcoming Global server recruitment banners that haven't ended yet, soonest first, with their pickup students.
  - [Get the Global roadmap](https://ba.joexyz.online/developers/reference/game-data/get-the-global-roadmap.md): Gets the Global server roadmap.
- [Shared content](https://ba.joexyz.online/developers/reference/shared-content.md): Timelines, timeline groups and rosters that their owners made public.
  - [Get a public timeline](https://ba.joexyz.online/developers/reference/shared-content/get-a-public-timeline.md): Gets a public timeline.
  - [Get a public timeline group](https://ba.joexyz.online/developers/reference/shared-content/get-a-public-timeline-group.md): Gets a public timeline group with its public timelines resolved.
  - [Get a public roster](https://ba.joexyz.online/developers/reference/shared-content/get-a-public-roster.md): Gets a public roster by the account's game server and friend code.
- [PVP statistics](https://ba.joexyz.online/developers/reference/pvp-statistics.md): Tactical Challenge statistics aggregated from every user's recorded matches (only matches marked includeInStatistics).
  - [Get statistics status](https://ba.joexyz.online/developers/reference/pvp-statistics/get-statistics-status.md): Reports when the statistics were last rebuilt.
  - [Get a season summary](https://ba.joexyz.online/developers/reference/pvp-statistics/get-a-season-summary.md): Gets totals and student usage for one season.
  - [List effective teams](https://ba.joexyz.online/developers/reference/pvp-statistics/list-effective-teams.md): Lists the most effective attack or defense teams of a season.
  - [Search counters to a defense team](https://ba.joexyz.online/developers/reference/pvp-statistics/search-counters-to-a-defense-team.md): Finds attack teams that were used against a defense team, with their win/loss records.
- [Your data](https://ba.joexyz.online/developers/reference/your-data.md): Your own data on Joe's Blue Archive Tools.
  - [Profile & preferences](https://ba.joexyz.online/developers/reference/your-data/profile-preferences.md)
    - [Get the current user](https://ba.joexyz.online/developers/reference/your-data/profile-preferences/get-the-current-user.md): Gets the user who owns the API key.
    - [Get preferences](https://ba.joexyz.online/developers/reference/your-data/profile-preferences/get-preferences.md): Gets your tool preferences, or the defaults if you never changed them.
    - [Update preferences](https://ba.joexyz.online/developers/reference/your-data/profile-preferences/update-preferences.md): Updates preferences.
  - [Formations](https://ba.joexyz.online/developers/reference/your-data/formations.md): Formations from the Formation Display tool.
    - [List formations](https://ba.joexyz.online/developers/reference/your-data/formations/list-formations.md): Lists your formations, newest first.
    - [Create a formation](https://ba.joexyz.online/developers/reference/your-data/formations/create-a-formation.md): Creates a formation and returns it.
    - [Get a formation](https://ba.joexyz.online/developers/reference/your-data/formations/get-a-formation.md): Gets one of your formations.
    - [Update a formation](https://ba.joexyz.online/developers/reference/your-data/formations/update-a-formation.md): Updates a formation and returns it.
    - [Delete a formation](https://ba.joexyz.online/developers/reference/your-data/formations/delete-a-formation.md): Deletes a formation.
  - [Timelines](https://ba.joexyz.online/developers/reference/your-data/timelines.md): Timelines from the Timeline Visualizer.
    - [List timelines](https://ba.joexyz.online/developers/reference/your-data/timelines/list-timelines.md): Lists your timelines, newest first.
    - [Create a timeline](https://ba.joexyz.online/developers/reference/your-data/timelines/create-a-timeline.md): Creates a timeline and returns it.
    - [Get a timeline](https://ba.joexyz.online/developers/reference/your-data/timelines/get-a-timeline.md): Gets one of your timelines.
    - [Update a timeline](https://ba.joexyz.online/developers/reference/your-data/timelines/update-a-timeline.md): Updates a timeline and returns it.
    - [Delete a timeline](https://ba.joexyz.online/developers/reference/your-data/timelines/delete-a-timeline.md): Deletes a timeline.
  - [Timeline groups](https://ba.joexyz.online/developers/reference/your-data/timeline-groups.md)
    - [List timeline groups](https://ba.joexyz.online/developers/reference/your-data/timeline-groups/list-timeline-groups.md): Lists your timeline groups, newest first.
    - [Create a timeline group](https://ba.joexyz.online/developers/reference/your-data/timeline-groups/create-a-timeline-group.md): Creates a timeline group and returns it.
    - [Get a timeline group](https://ba.joexyz.online/developers/reference/your-data/timeline-groups/get-a-timeline-group.md): Gets one of your timeline groups.
    - [Update a timeline group](https://ba.joexyz.online/developers/reference/your-data/timeline-groups/update-a-timeline-group.md): Updates a timeline group and returns it.
    - [Delete a timeline group](https://ba.joexyz.online/developers/reference/your-data/timeline-groups/delete-a-timeline-group.md): Deletes a timeline group.
  - [Rosters](https://ba.joexyz.online/developers/reference/your-data/rosters.md): Rosters of your in-game accounts.
    - [List rosters](https://ba.joexyz.online/developers/reference/your-data/rosters/list-rosters.md): Lists your rosters, newest first.
    - [Create a roster](https://ba.joexyz.online/developers/reference/your-data/rosters/create-a-roster.md): Creates a roster and returns it.
    - [Get a roster](https://ba.joexyz.online/developers/reference/your-data/rosters/get-a-roster.md): Gets one of your rosters.
    - [Update a roster](https://ba.joexyz.online/developers/reference/your-data/rosters/update-a-roster.md): Updates a roster and returns it.
    - [Delete a roster](https://ba.joexyz.online/developers/reference/your-data/rosters/delete-a-roster.md): Deletes a roster.
  - [Gift planner](https://ba.joexyz.online/developers/reference/your-data/gift-planner.md): Gift inventories from the Bond EXP calculator, and the students you plan to give gifts to (targets).
    - [List gift planner](https://ba.joexyz.online/developers/reference/your-data/gift-planner/list-gift-planner.md): Lists your gift planner, newest first.
    - [Create a gift inventory](https://ba.joexyz.online/developers/reference/your-data/gift-planner/create-a-gift-inventory.md): Creates a gift inventory and returns it.
    - [Get a gift inventory](https://ba.joexyz.online/developers/reference/your-data/gift-planner/get-a-gift-inventory.md): Gets one of your gift planner.
    - [Update a gift inventory](https://ba.joexyz.online/developers/reference/your-data/gift-planner/update-a-gift-inventory.md): Updates a gift inventory and returns it.
    - [Delete a gift inventory](https://ba.joexyz.online/developers/reference/your-data/gift-planner/delete-a-gift-inventory.md): Deletes a gift inventory.
    - [Create a gift target](https://ba.joexyz.online/developers/reference/your-data/gift-planner/create-a-gift-target.md): Adds a student to plan gifts for.
    - [Get a gift target](https://ba.joexyz.online/developers/reference/your-data/gift-planner/get-a-gift-target.md): Gets one gift target.
    - [Update a gift target](https://ba.joexyz.online/developers/reference/your-data/gift-planner/update-a-gift-target.md): Updates a gift target.
    - [Delete a gift target](https://ba.joexyz.online/developers/reference/your-data/gift-planner/delete-a-gift-target.md): Deletes a gift target.
  - [PVP tracker](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker.md): Your Tactical Challenge seasons, matches and presets.
    - [Matches](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/matches.md)
      - [List matches](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/matches/list-matches.md): Lists the season's matches, newest first.
      - [Record a match](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/matches/record-a-match.md): Records a match.
      - [Get a match](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/matches/get-a-match.md): Gets a match.
      - [Update a match](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/matches/update-a-match.md): Updates a match.
      - [Delete a match](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/matches/delete-a-match.md): Deletes a match.
    - [Formation presets](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/formation-presets.md)
      - [List formation presets](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/formation-presets/list-formation-presets.md): Lists your saved teams for the season.
      - [Create a formation preset](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/formation-presets/create-a-formation-preset.md): Saves one of your teams.
      - [Get a formation preset](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/formation-presets/get-a-formation-preset.md): Gets a formation preset.
      - [Update a formation preset](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/formation-presets/update-a-formation-preset.md): Updates a formation preset.
      - [Delete a formation preset](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/formation-presets/delete-a-formation-preset.md): Deletes a formation preset.
    - [Opponents](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/opponents.md): Opponent presets group the teams and matches of one opponent.
      - [List opponents](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/opponents/list-opponents.md): Lists opponent presets, most recently recorded first.
      - [Create an opponent](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/opponents/create-an-opponent.md): Creates an opponent preset.
      - [Get an opponent](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/opponents/get-an-opponent.md): Gets an opponent preset, with its most recent team as latestTeam.
      - [Update an opponent](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/opponents/update-an-opponent.md): Updates name, opponentName and/or opponentStudentRepId.
      - [Delete an opponent](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/opponents/delete-an-opponent.md): Deletes an opponent preset.
      - [List an opponent's teams](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/opponents/list-an-opponents-teams.md): Lists the distinct teams seen for an opponent, from matches and saved enemy teams.
    - [Enemy teams](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/enemy-teams.md): Teams you have seen opponents use, saved outside of a match.
      - [Save an enemy team](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/enemy-teams/save-an-enemy-team.md): Saves an enemy team, optionally for an opponent (enemyPresetId).
      - [Get an enemy team](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/enemy-teams/get-an-enemy-team.md): Gets an enemy team.
      - [Update an enemy team](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/enemy-teams/update-an-enemy-team.md): Updates matchType and/or team.
      - [Delete an enemy team](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/enemy-teams/delete-an-enemy-team.md): Deletes an enemy team.
    - [List seasons](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/list-seasons.md): Lists your seasons: active ones in display order, then archived ones.
    - [Create a season](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/create-a-season.md): Creates a season.
    - [Get a season](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/get-a-season.md): Gets a season.
    - [Update a season](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/update-a-season.md): Updates name, gameServer, seasonNumber and/or archived.
    - [Delete a season](https://ba.joexyz.online/developers/reference/your-data/pvp-tracker/delete-a-season.md): Deletes a season with all of its matches, presets and enemy teams.
  - [Recruitment tracker](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker.md): Your recruitment (gacha) history per account.
    - [Sessions](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker/sessions.md): A session is one banner's pulls.
      - [List sessions](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker/sessions/list-sessions.md): Lists the account's sessions, newest first.
      - [Record a session](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker/sessions/record-a-session.md): Records a session.
      - [Get a session](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker/sessions/get-a-session.md): Gets a session.
      - [Update a session](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker/sessions/update-a-session.md): Updates a session; later sessions of the account are recalculated.
      - [Delete a session](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker/sessions/delete-a-session.md): Deletes a session.
    - [List accounts](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker/list-accounts.md): Lists your recruitment accounts: active ones in display order, then archived ones (archived: true).
    - [Create an account](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker/create-an-account.md): Creates a recruitment account.
    - [Get an account](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker/get-an-account.md): Gets an account with its sessions, newest first.
    - [Update an account](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker/update-an-account.md): Updates name, gameServer, permanentCharge, limitedCharge and/or archived.
    - [Delete an account](https://ba.joexyz.online/developers/reference/your-data/recruitment-tracker/delete-an-account.md): Deletes an account and all of its sessions.
