RAWG.io

https://rawgthedocs.orels.sh/
Admin
RAWG.io is a comprehensive video game database and discovery service, offering an extensive API for...
Tokens:2,503
Snippets:27
Trust Score:5
Update:1 year ago
Show doc for...
Tokens:
Raw
### API: GET /collections

Source: https://rawgthedocs.orels.sh/api/collections

Returns new collections.

```APIDOC
GET /
  Description: Returns new collections
```

--------------------------------

### API: GET /collections/lists/popular

Source: https://rawgthedocs.orels.sh/api/collections

Returns a list of popular collections.

```APIDOC
GET /lists/popular
  Description: Returns popular collections
```

--------------------------------

### API: GET /collections/lists/main

Source: https://rawgthedocs.orels.sh/api/collections

Returns a list of main collections, which is currently the same as popular collections.

```APIDOC
GET /lists/main
  Description: Returns popular collections (same as /lists/popular)
```

--------------------------------

### API Endpoint: GET /users/:user/collections

Source: https://rawgthedocs.orels.sh/api/users

Returns the collections created by a specified user.

```APIDOC
GET /:user/collections:
  description: User's collections
  returns: Collections created by the specified user
```

--------------------------------

### API Endpoint: GET /users/:user/favorites

Source: https://rawgthedocs.orels.sh/api/users

Retrieves the favorite games for a specified user.

```APIDOC
GET /:user/favorites:
  description: User's favorites games
  returns: Favorite games for the specified user
```

--------------------------------

### API Endpoint: GET /users/:user/reviews

Source: https://rawgthedocs.orels.sh/api/users

Retrieves the reviews posted by a specified user.

```APIDOC
GET /:user/reviews:
  description: User's reviews
  returns: Reviews posted by the specified user
```

--------------------------------

### API Endpoint: GET /users/:user

Source: https://rawgthedocs.orels.sh/api/users

Retrieves the profile data for a specified user. The ':user' slug can be replaced with 'current' to fetch data for the currently authorized user.

```APIDOC
GET /:user:
  description: User's profile
  returns: User profile data
```

--------------------------------

### API Endpoint: GET /users/:user/games

Source: https://rawgthedocs.orels.sh/api/users

Fetches the list of games associated with a specific user. This endpoint supports filtering by various game statuses, which are enumerated.

```APIDOC
GET /:user/games:
  description: User's games
  returns: Games for the selected user
  status_options:
    - playing
    - toplay
    - beated
    - dropped
    - yet
    - owned
```

--------------------------------

### API: GET /collections/:collectionSlug/feed

Source: https://rawgthedocs.orels.sh/api/collections

Returns the list of games contained within a specific collection.

```APIDOC
GET /:collectionSlug/feed
  Description: Returns the games in a collection
```

--------------------------------

### API: GET /collections/:collectionSlug

Source: https://rawgthedocs.orels.sh/api/collections

Returns the collection data, without games, for a specific collection identified by its slug.

```APIDOC
GET /:collectionSlug
  Description: Returns the collection data, without games
```

--------------------------------

### RAWG API Endpoint Reference

Source: https://rawgthedocs.orels.sh/api

A comprehensive overview of the available API endpoints for the RAWG.io platform, categorized by resource path and listing supported HTTP methods for each.

```APIDOC
/users
  GET /:user
  GET /:user/games
  GET /:user/favorites
  GET /:user/collections
  GET /:user/reviews
  PATCH /current/games/:gameId
/auth
  POST /login
/games
  GET /
  GET /:gameSlug
  GET /:gameSlug/suggested
  GET /:gameSlug/collections
  PATCH /:gameSlug
  GET /:gameSlug/screenshots
/collections
  GET /
  GET /:collectionSlug
  GET /:collectionSlug/feed
  POST /:collectionSlug/games
  GET /lists/popular
  GET /lists/main
  PATCH /:collectionId
```

--------------------------------

### RAWG API General Usage Rules

Source: https://rawgthedocs.orels.sh/api

Outlines the essential rules for interacting with the RAWG.io API, including identifying your application, avoiding database dumps, preventing clones, and requiring attribution.

```APIDOC
Rules:
- Identify your app with `User-Agent` header
- Don't dump the database
- Don't build RAWG clones
- Link to RAWG as your data source
```

--------------------------------

### RAWG API Endpoints Overview

Source: https://rawgthedocs.orels.sh/index

This section outlines the available API endpoints for interacting with the RAWG platform, covering user data, authentication, game information, and collections. Each endpoint specifies the HTTP method and the resource path.

```APIDOC
API Endpoints:
  /users:
    GET /:user
    GET /:user/games
    GET /:user/favorites
    GET /:user/collections
    GET /:user/reviews
    PATCH /current/games/:gameId
  /auth:
    POST /login
  /games:
    GET /
    GET /:gameSlug
    GET /:gameSlug/suggested
    GET /:gameSlug/collections
    PATCH /:gameSlug
    GET /:gameSlug/screenshots
  /collections:
    GET /
    GET /:collectionSlug
    GET /:collectionSlug/feed
    POST /:collectionSlug/games
    GET /lists/popular
    GET /lists/main
    PATCH /:collectionId
```

--------------------------------

### Retrieve Suggested Games for a Specific Game

Source: https://rawgthedocs.orels.sh/api/games

This endpoint leverages RAWG's AI discovery system to return a list of games suggested as similar or related to the base game identified by `gameSlug`.

```APIDOC
GET /games/:gameSlug/suggested
  Description: Returns suggested games based on the provided game slug, using RAWG's AI.
```

--------------------------------

### API Endpoint: /users Overview

Source: https://rawgthedocs.orels.sh/api/users

Provides a general overview of user data related routes. It notes that 'current' can be used in place of a user slug for the currently authorized user and that authorization is required for these routes.

```APIDOC
/users:
  description: User data related routes
  notes: You can supply `current` in place of user slug to get data for the currently authorized user. Requires authorization.
```

--------------------------------

### RAWG API Pagination Query Parameters

Source: https://rawgthedocs.orels.sh/api

Explains the query parameters used for pagination in RAWG API requests, specifying the requested page number and the maximum page size.

```APIDOC
Pagination Parameters:
- `page`: The page to request the items for, based on the `page_size` (20 by default).
- `page_size`: The size of the page, 40 is the max value.
```

--------------------------------

### Retrieve Game Screenshots from RAWG API

Source: https://rawgthedocs.orels.sh/api/games

This endpoint returns a paginated list of screenshots associated with the game identified by `gameSlug`. It provides visual assets for the game.

```APIDOC
GET /games/:gameSlug/screenshots
  Description: Returns a page of screenshots for the specified game.
```

--------------------------------

### Authenticate User with POST /login

Source: https://rawgthedocs.orels.sh/api/auth

This API endpoint allows users to log in and obtain an authentication token. It is part of the authentication and authorization routes and is essential for accessing protected resources.

```APIDOC
Endpoint: POST /login
Description: Login
Purpose: Generates an auth token for the user
```

--------------------------------

### Retrieve All Games from RAWG API

Source: https://rawgthedocs.orels.sh/api/games

This endpoint returns a paginated list of all games available on rawg.io, ordered by popularity. It's important to note that large-volume data exports are discouraged and require prior communication with the RAWG team.

```APIDOC
GET /games
  Description: Returns all games, ordered by popularity.
  Note: Large-volume exports require prior approval via email.
```

--------------------------------

### RAWG API Authentication Header Requirements

Source: https://rawgthedocs.orels.sh/api

Details the required HTTP headers for authenticating requests to the RAWG API, including the Content-Type and the token header format.

```APIDOC
Authentication Headers:
- `Content-Type`: `application/json`
- `token`: `Token <key from the api>`
```

--------------------------------

### RAWG API Common List Response Structure

Source: https://rawgthedocs.orels.sh/api

Describes the standard properties returned by RAWG API endpoints that provide a list of items, including total count, pagination links, and the array of results.

```APIDOC
Common List Response Properties:
- `count`: The total amount of items in that particular database collection.
- `next`: The URL of the next page (if exists).
- `prev`: The URL of the previous page (if exists).
- `results`: The list of items.
```

--------------------------------

### Retrieve Single Game by Slug from RAWG API

Source: https://rawgthedocs.orels.sh/api/games

This endpoint fetches detailed information for a single game, identified by its unique slug. It provides specific data for the requested game.

```APIDOC
GET /games/:gameSlug
  Description: Returns a single game identified by its slug.
```

--------------------------------

### API: POST /collections/:collectionSlug/games

Source: https://rawgthedocs.orels.sh/api/collections

Adds multiple games to a specified collection. This is an authorized route requiring a 'token' header.

```APIDOC
POST /:collectionSlug/games
  Description: Adds multiple games to the collection
  Authorization: token header required
```

--------------------------------

### Update Game Data via RAWG API

Source: https://rawgthedocs.orels.sh/api/games

This endpoint allows for partial updates to a game's data, identified by its slug. Users should ensure they base their edits on the most recently retrieved game data to avoid conflicts.

```APIDOC
PATCH /games/:gameSlug
  Description: Edits existing game data by overwriting with provided data.
  Note: Edits should be based on recently requested game data.
```

--------------------------------

### Retrieve Collections Containing a Specific Game

Source: https://rawgthedocs.orels.sh/api/games

This endpoint returns a paginated list of collections that include the game specified by `gameSlug`. It helps identify how a game is categorized across different user or official collections.

```APIDOC
GET /games/:gameSlug/collections
  Description: Returns a page of collections that include the specified game.
```

--------------------------------

### API Endpoint: PATCH /users/current/games/:gameId

Source: https://rawgthedocs.orels.sh/api/users

Updates the status of a specific game for the currently authorized user. This operation requires a 'token' header for authorization and provides a list of valid game statuses.

```APIDOC
PATCH /current/games/:gameId:
  description: Game status update
  notes: Update a game by ID for currently authorized user. This is an authorized route. A `token` header is required.
  parameters:
    - gameId: The ID of the game to update.
  status_options:
    - playing
    - toplay
    - beated
    - dropped
    - yet
    - owned
```

--------------------------------

### API: PATCH /collections/:collectionId

Source: https://rawgthedocs.orels.sh/api/collections

Updates a collection by its ID for the currently authorized user. This route requires a 'token' header and returns the updated collection data.

```APIDOC
PATCH /:collectionId
  Description: Update a collection by ID for currently authorized user. Returns updated collection data.
  Authorization: token header required
```
Tokens:
Raw