Skip to content

Commit

Permalink
chore: update docs URL domain in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@luchaos
luchaos authored Nov 20, 2023
1 parent 317ad95 commit bfb2635
Showing 1 changed file with 35 additions and 35 deletions.
70 changes: 35 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
</p>

<p align="center">
<a href="https://retroachievements-api-js.vercel.app/getting-started.html"><strong>Documentation: Get Started</strong></a>
<a href="https://api-docs.retroachievements.org/getting-started.html"><strong>Documentation: Get Started</strong></a>
<br />
</p>

Expand All @@ -28,10 +28,10 @@

Learn how to authenticate and start pulling data from RetroAchievements on our documentation website.

- [Get started](https://retroachievements-api-js.vercel.app/getting-started.html)
- [Get a user's profile information](https://retroachievements-api-js.vercel.app/v1/users/get-user-summary.html)
- [Look up games a user has completed](https://retroachievements-api-js.vercel.app/v1/users/get-user-completed-games.html)
- [Get a game's metadata](https://retroachievements-api-js.vercel.app/v1/games/get-game-extended.html)
- [Get started](https://api-docs.retroachievements.org/getting-started.html)
- [Get a user's profile information](https://api-docs.retroachievements.org/v1/users/get-user-summary.html)
- [Look up games a user has completed](https://api-docs.retroachievements.org/v1/users/get-user-completed-games.html)
- [Get a game's metadata](https://api-docs.retroachievements.org/v1/games/get-game-extended.html)

## Installation

Expand Down Expand Up @@ -76,51 +76,51 @@ Click the function names to open their complete docs on the docs site.

### Users

- [`getAchievementsEarnedBetween()`](https://retroachievements-api-js.vercel.app/v1/users/get-achievements-earned-between.html) - Get a list of achievements earned by a user between two dates.
- [`getAchievementsEarnedOnDay()`](https://retroachievements-api-js.vercel.app/v1/users/get-achievements-earned-on-day.html) - Get a list of achievements earned by a user on a given date.
- [`getGameInfoAndUserProgress()`](https://retroachievements-api-js.vercel.app/v1/users/get-game-info-and-user-progress.html) - Get metadata about a game as well as a user's progress on that game.
- [`getUserAwards()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-awards.html) - Get a list of a user's site awards/badges.
- [`getUserClaims()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-claims.html) - Get a list of set claims made over the lifetime of a user.
- [`getUserCompletedGames()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-completed-games.html) - Get hardcore and softcore completion metadata about games a user has played.
- [`getUserGameRankAndScore()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-game-rank-and-score.html) - Get metadata about how a user has performed on a given game.
- [`getUserPoints()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-points.html) - Get a user's total hardcore and softcore points.
- [`getUserProgress()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-progress.html) - Get a user's progress on a list of specified games.
- [`getUserRecentAchievements()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-recent-achievements.html) - Get a list of achievements recently earned by the user.
- [`getUserRecentlyPlayedGames()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-recently-played-games.html) - Get a list of games a user has recently played.
- [`getUserSummary()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-summary.html) - Get a user's profile metadata.
- [`getAchievementsEarnedBetween()`](https://api-docs.retroachievements.org/v1/users/get-achievements-earned-between.html) - Get a list of achievements earned by a user between two dates.
- [`getAchievementsEarnedOnDay()`](https://api-docs.retroachievements.org/v1/users/get-achievements-earned-on-day.html) - Get a list of achievements earned by a user on a given date.
- [`getGameInfoAndUserProgress()`](https://api-docs.retroachievements.org/v1/users/get-game-info-and-user-progress.html) - Get metadata about a game as well as a user's progress on that game.
- [`getUserAwards()`](https://api-docs.retroachievements.org/v1/users/get-user-awards.html) - Get a list of a user's site awards/badges.
- [`getUserClaims()`](https://api-docs.retroachievements.org/v1/users/get-user-claims.html) - Get a list of set claims made over the lifetime of a user.
- [`getUserCompletedGames()`](https://api-docs.retroachievements.org/v1/users/get-user-completed-games.html) - Get hardcore and softcore completion metadata about games a user has played.
- [`getUserGameRankAndScore()`](https://api-docs.retroachievements.org/v1/users/get-user-game-rank-and-score.html) - Get metadata about how a user has performed on a given game.
- [`getUserPoints()`](https://api-docs.retroachievements.org/v1/users/get-user-points.html) - Get a user's total hardcore and softcore points.
- [`getUserProgress()`](https://api-docs.retroachievements.org/v1/users/get-user-progress.html) - Get a user's progress on a list of specified games.
- [`getUserRecentAchievements()`](https://api-docs.retroachievements.org/v1/users/get-user-recent-achievements.html) - Get a list of achievements recently earned by the user.
- [`getUserRecentlyPlayedGames()`](https://api-docs.retroachievements.org/v1/users/get-user-recently-played-games.html) - Get a list of games a user has recently played.
- [`getUserSummary()`](https://api-docs.retroachievements.org/v1/users/get-user-summary.html) - Get a user's profile metadata.

### Games

- [`getAchievementCount()`](https://retroachievements-api-js.vercel.app/v1/games/get-achievement-count.html) - Get the list of achievement IDs for a game.
- [`getAchievementDistribution()`](https://retroachievements-api-js.vercel.app/v1/games/get-achievement-distribution.html) - Get how many players have unlocked how many achievements for a game.
- [`getGame()`](https://retroachievements-api-js.vercel.app/v1/games/get-game.html) - Get basic metadata about a game.
- [`getGameExtended()`](https://retroachievements-api-js.vercel.app/v1/games/get-game-extended.html) - Get extended metadata about a game.
- [`getGameRankAndScore()`](https://retroachievements-api-js.vercel.app/v1/games/get-game-rank-and-score.html) - Get a list of either the latest masters or highest points earners for a game.
- [`getGameRating()`](https://retroachievements-api-js.vercel.app/v1/games/get-game-rating.html) - Get how users have rated a game.
- [`getAchievementCount()`](https://api-docs.retroachievements.org/v1/games/get-achievement-count.html) - Get the list of achievement IDs for a game.
- [`getAchievementDistribution()`](https://api-docs.retroachievements.org/v1/games/get-achievement-distribution.html) - Get how many players have unlocked how many achievements for a game.
- [`getGame()`](https://api-docs.retroachievements.org/v1/games/get-game.html) - Get basic metadata about a game.
- [`getGameExtended()`](https://api-docs.retroachievements.org/v1/games/get-game-extended.html) - Get extended metadata about a game.
- [`getGameRankAndScore()`](https://api-docs.retroachievements.org/v1/games/get-game-rank-and-score.html) - Get a list of either the latest masters or highest points earners for a game.
- [`getGameRating()`](https://api-docs.retroachievements.org/v1/games/get-game-rating.html) - Get how users have rated a game.

### Achievements

- [`getAchievementUnlocks()`](https://retroachievements-api-js.vercel.app/v1/achievements/get-achievement-unlocks.html) - Get a list of users who have earned an achievement.
- [`getAchievementUnlocks()`](https://api-docs.retroachievements.org/v1/achievements/get-achievement-unlocks.html) - Get a list of users who have earned an achievement.

### Consoles

- [`getConsoleIds()`](https://retroachievements-api-js.vercel.app/v1/consoles/get-console-ids.html) - Get the complete list of console ID and name pairs on the site.
- [`getGameList()`](https://retroachievements-api-js.vercel.app/v1/consoles/get-game-list.html) - Get the complete list of games for a console.
- [`getConsoleIds()`](https://api-docs.retroachievements.org/v1/consoles/get-console-ids.html) - Get the complete list of console ID and name pairs on the site.
- [`getGameList()`](https://api-docs.retroachievements.org/v1/consoles/get-game-list.html) - Get the complete list of games for a console.

### Feed

- [`getAchievementOfTheWeek()`](https://retroachievements-api-js.vercel.app/v1/feed/get-achievement-of-the-week.html) - Get comprehensive metadata about the current Achievement of the Week.
- [`getActiveClaims()`](https://retroachievements-api-js.vercel.app/v1/feed/get-active-claims.html) - Get all active set claims on the site.
- [`getClaims()`](https://retroachievements-api-js.vercel.app/v1/feed/get-claims.html) - Get all claims of other kinds on the site.
- [`getTopTenUsers()`](https://retroachievements-api-js.vercel.app/v1/feed/get-top-ten-users.html) - Get the list of top ten points earners.
- [`getAchievementOfTheWeek()`](https://api-docs.retroachievements.org/v1/feed/get-achievement-of-the-week.html) - Get comprehensive metadata about the current Achievement of the Week.
- [`getActiveClaims()`](https://api-docs.retroachievements.org/v1/feed/get-active-claims.html) - Get all active set claims on the site.
- [`getClaims()`](https://api-docs.retroachievements.org/v1/feed/get-claims.html) - Get all claims of other kinds on the site.
- [`getTopTenUsers()`](https://api-docs.retroachievements.org/v1/feed/get-top-ten-users.html) - Get the list of top ten points earners.

### Tickets

- [Get Ticket by ID](https://retroachievements-api-js.vercel.app/v1/tickets/get-ticket-by-id.html)
- [Get Most Ticketed Games](https://retroachievements-api-js.vercel.app/v1/tickets/get-most-ticketed-games.html)
- [Get Most Recent Tickets](https://retroachievements-api-js.vercel.app/v1/tickets/get-most-recent-tickets.html)
- [Get Game Ticket Stats](https://retroachievements-api-js.vercel.app/v1/tickets/get-game-ticket-stats.html)
- [Get Developer Ticket Stats](https://retroachievements-api-js.vercel.app/v1/tickets/get-developer-ticket-stats.html)
- [Get Ticket by ID](https://api-docs.retroachievements.org/v1/tickets/get-ticket-by-id.html)
- [Get Most Ticketed Games](https://api-docs.retroachievements.org/v1/tickets/get-most-ticketed-games.html)
- [Get Most Recent Tickets](https://api-docs.retroachievements.org/v1/tickets/get-most-recent-tickets.html)
- [Get Game Ticket Stats](https://api-docs.retroachievements.org/v1/tickets/get-game-ticket-stats.html)
- [Get Developer Ticket Stats](https://api-docs.retroachievements.org/v1/tickets/get-developer-ticket-stats.html)

## Examples

Expand Down

0 comments on commit bfb2635

Please sign in to comment.