RomM

RomM Activity API

The activity API from RomM — 3 operation(s) for activity.

GitHub OpenAPI

Operations 4

GET /api/activity Get All Activity #
GET /api/activity/rom/{rom_id} Get Rom Activity #
POST /api/activity/heartbeat Device Heartbeat #
DELETE /api/activity/heartbeat Clear Device Activity #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/romm/openapi/romm-activity-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-detailed-rom-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-simple-rom-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-config-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-body-update-rom-api-roms-id-put-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-platform-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-search-rom-schema-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/romm/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/romm:romm-activity-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

romm-activity-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: RomM Activity API
  version: 5.4.0
tags:
- name: Activity
paths:
  /api/activity:
    get:
      tags:
      - Activity
      summary: Get All Activity
      description: Return every currently active play session across all users.
      operationId: get_all_activity_api_activity_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ActivityEntrySchema'
                type: array
                title: Response Get All Activity Api Activity Get
      security:
      - OAuth2PasswordBearer:
        - roms.user.read
      - HTTPBasic: []
  /api/activity/rom/{rom_id}:
    get:
      tags:
      - Activity
      summary: Get Rom Activity
      description: Return all active play sessions for a specific ROM.
      operationId: get_rom_activity_api_activity_rom__rom_id__get
      security:
      - OAuth2PasswordBearer:
        - roms.user.read
      - HTTPBasic: []
      parameters:
      - name: rom_id
        in: path
        required: true
        schema:
          type: integer
          title: Rom Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActivityEntrySchema'
                title: Response Get Rom Activity Api Activity Rom  Rom Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/activity/heartbeat:
    post:
      tags:
      - Activity
      summary: Device Heartbeat
      description: 'Heartbeat endpoint for external devices (muOS, Android, etc.).


        Called periodically by devices while the user is playing a game. Writes

        activity state to Redis and sends an ``activity:update`` event to the

        users who can see the ROM.'
      operationId: device_heartbeat_api_activity_heartbeat_post
      security:
      - OAuth2PasswordBearer:
        - roms.user.write
      - HTTPBasic: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceHeartbeatPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityEntrySchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Activity
      summary: Clear Device Activity
      description: Immediately clear an active session for a device (e.g. on graceful exit).
      operationId: clear_device_activity_api_activity_heartbeat_delete
      security:
      - OAuth2PasswordBearer:
        - roms.user.write
      - HTTPBasic: []
      parameters:
      - name: device_id
        in: query
        required: true
        schema:
          type: string
          title: Device Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DeviceHeartbeatPayload:
      properties:
        rom_id:
          type: integer
          minimum: 1.0
          title: Rom Id
        device_id:
          type: string
          maxLength: 255
          minLength: 1
          title: Device Id
      type: object
      required:
      - rom_id
      - device_id
      title: DeviceHeartbeatPayload
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ActivityEntrySchema:
      properties:
        user_id:
          type: integer
          title: User Id
        username:
          type: string
          title: Username
        avatar_path:
          type: string
          title: Avatar Path
        rom_id:
          type: integer
          title: Rom Id
        rom_name:
          type: string
          title: Rom Name
        rom_cover_path:
          type: string
          title: Rom Cover Path
          default: ''
        screenshot_path:
          type: string
          title: Screenshot Path
          default: ''
        platform_slug:
          type: string
          title: Platform Slug
        platform_name:
          type: string
          title: Platform Name
        device_id:
          type: string
          title: Device Id
        device_type:
          type: string
          title: Device Type
        started_at:
          type: string
          title: Started At
      type: object
      required:
      - user_id
      - username
      - avatar_path
      - rom_id
      - rom_name
      - platform_slug
      - platform_name
      - device_id
      - device_type
      - started_at
      title: ActivityEntrySchema
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes:
            me.read: View your profile
            roms.read: View ROMs
            platforms.read: View platforms
            assets.read: View assets
            devices.read: View devices
            firmware.read: View firmware
            roms.user.read: View user-rom properties
            collections.read: View collections
            playlists.read: View music playlists
            me.write: Modify your profile
            assets.write: Modify assets
            devices.write: Modify devices
            roms.user.write: Modify user-rom properties
            collections.write: Modify collections
            playlists.write: Modify music playlists
            roms.write: Modify ROMs
            platforms.write: Modify platforms
            firmware.write: Modify firmware
            users.read: View users
            users.write: Modify users
            tasks.run: Run tasks
            logs.read: View backend logs
          tokenUrl: /token
    HTTPBasic:
      type: http
      scheme: basic