Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(API_GetConsoleIDs): add IconURL field #37

Merged
merged 6 commits into from
Feb 29, 2024
Merged

docs(API_GetConsoleIDs): add IconURL field #37

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
84522fb
Updated docs json example
Feb 26, 2024
07b7e51
chore: format
wescopeland Feb 26, 2024
afab44b
Updated API_GetConsoleIDs to reflect latest changes
Feb 29, 2024
908f58c
Merge branch 'main' into main
WedgeSparda Feb 29, 2024
546dc96
Revert "Updated API_GetConsoleIDs to reflect latest changes"
Feb 29, 2024
bd37882
Merge branch 'main' of github.com:WedgeSparda/api-docs
Feb 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions docs/v1/get-console-ids.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,12 @@ The systems list can be found by selecting the "Games" menu from the site navbar

### Query Parameters

| Name | Required? | Description |
| :--- | :-------- | :---------------- |
| `z` | Yes | Your username. |
| `y` | Yes | Your web API key. |
| Name | Required? | Description |
| :--- | :-------- | :----------------------------------------------------------------------- |
| `z` | Yes | Your username. |
| `y` | Yes | Your web API key. |
| `a` | | If 1, only return active systems. Defaults to 0. |
| `g` | | If 1, only return gaming systems (not Hubs, Events, etc). Defaults to 0. |

## Client Library

Expand All @@ -50,7 +52,13 @@ const consoleIds = await getConsoleIds(authorization);

```json [HTTP Response]
[
{ "ID": 1, "Name": "Mega Drive" }
{
"ID": 1,
"Name": "Mega Drive",
"IconURL": "https://static.retroachievements.org/assets/images/system/md.png",
"Active": true,
"IsGameSystem": true
wescopeland marked this conversation as resolved.
Show resolved Hide resolved
}
// ...
]
```
Expand Down
Loading