RomM

RomM Platforms API

The platforms API from RomM — 5 operation(s) for platforms.

GitHub OpenAPI

Operations 8

POST /api/platforms Add Platform #
GET /api/platforms Get Platforms #
GET /api/platforms/identifiers Get Platform Identifiers #
GET /api/platforms/supported Get Supported Platforms Endpoint #
GET /api/platforms/filesystem Get Filesystem Platforms Endpoint #
GET /api/platforms/{id} Get Platform #
PUT /api/platforms/{id} Update Platform #
DELETE /api/platforms/{id} Delete Platform #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/romm/openapi/romm-platforms-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

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-platforms-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-platforms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: RomM Platforms API
  version: 5.4.0
tags:
- name: Platforms
paths:
  /api/platforms:
    post:
      tags:
      - Platforms
      summary: Add Platform
      description: Create a platform.
      operationId: add_platform_api_platforms_post
      security:
      - OAuth2PasswordBearer:
        - platforms.write
      - HTTPBasic: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Body_add_platform_api_platforms_post'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Platforms
      summary: Get Platforms
      description: Retrieve platforms.
      operationId: get_platforms_api_platforms_get
      security:
      - OAuth2PasswordBearer:
        - platforms.read
      - HTTPBasic: []
      parameters:
      - name: updated_after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Filter platforms updated after this datetime (ISO 8601 format with timezone information).
          title: Updated After
        description: Filter platforms updated after this datetime (ISO 8601 format with timezone information).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlatformSchema'
                title: Response Get Platforms Api Platforms Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/platforms/identifiers:
    get:
      tags:
      - Platforms
      summary: Get Platform Identifiers
      description: Retrieve platform identifiers.
      operationId: get_platform_identifiers_api_platforms_identifiers_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  type: integer
                type: array
                title: Response Get Platform Identifiers Api Platforms Identifiers Get
      security:
      - OAuth2PasswordBearer:
        - platforms.read
      - HTTPBasic: []
  /api/platforms/supported:
    get:
      tags:
      - Platforms
      summary: Get Supported Platforms Endpoint
      description: Retrieve the list of supported platforms.
      operationId: get_supported_platforms_endpoint_api_platforms_supported_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PlatformSchema'
                type: array
                title: Response Get Supported Platforms Endpoint Api Platforms Supported Get
      security:
      - OAuth2PasswordBearer:
        - platforms.read
      - HTTPBasic: []
  /api/platforms/filesystem:
    get:
      tags:
      - Platforms
      summary: Get Filesystem Platforms Endpoint
      description: Retrieve platform folders on disk that have no database row yet.
      operationId: get_filesystem_platforms_endpoint_api_platforms_filesystem_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PlatformSchema'
                type: array
                title: Response Get Filesystem Platforms Endpoint Api Platforms Filesystem Get
      security:
      - OAuth2PasswordBearer:
        - platforms.read
      - HTTPBasic: []
  /api/platforms/{id}:
    get:
      tags:
      - Platforms
      summary: Get Platform
      description: Retrieve a platform by ID.
      operationId: get_platform_api_platforms__id__get
      security:
      - OAuth2PasswordBearer:
        - platforms.read
      - HTTPBasic: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          minimum: 1
          description: Platform id.
          title: Id
        description: Platform id.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformSchema'
        '404':
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Platforms
      summary: Update Platform
      description: Update a platform.
      operationId: update_platform_api_platforms__id__put
      security:
      - OAuth2PasswordBearer:
        - platforms.write
      - HTTPBasic: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          minimum: 1
          description: Platform id.
          title: Id
        description: Platform id.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Body_update_platform_api_platforms__id__put'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformSchema'
        '404':
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Platforms
      summary: Delete Platform
      description: Delete a platform by ID.
      operationId: delete_platform_api_platforms__id__delete
      security:
      - OAuth2PasswordBearer:
        - platforms.write
      - HTTPBasic: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          minimum: 1
          description: Platform id.
          title: Id
        description: Platform id.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '404':
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PlatformSchema:
      properties:
        id:
          type: integer
          title: Id
        slug:
          type: string
          title: Slug
        fs_slug:
          type: string
          title: Fs Slug
        rom_count:
          type: integer
          title: Rom Count
        name:
          type: string
          title: Name
        igdb_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Igdb Slug
        moby_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Moby Slug
        hltb_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Hltb Slug
        libretro_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Libretro Slug
        custom_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Custom Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        igdb_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Igdb Id
        sgdb_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Sgdb Id
        moby_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Moby Id
        launchbox_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Launchbox Id
        ss_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Ss Id
        ra_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Ra Id
        hasheous_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Hasheous Id
        tgdb_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Tgdb Id
        flashpoint_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Flashpoint Id
        category:
          anyOf:
          - type: string
          - type: 'null'
          title: Category
        generation:
          anyOf:
          - type: integer
          - type: 'null'
          title: Generation
        family_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Family Name
        family_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Family Slug
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
        url_logo:
          anyOf:
          - type: string
          - type: 'null'
          title: Url Logo
        firmware:
          items:
            $ref: '#/components/schemas/FirmwareSchema'
          type: array
          title: Firmware
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
        fs_size_bytes:
          type: integer
          title: Fs Size Bytes
        is_unidentified:
          type: boolean
          title: Is Unidentified
        is_identified:
          type: boolean
          title: Is Identified
        missing_from_fs:
          type: boolean
          title: Missing From Fs
        display_name:
          type: string
          title: Display Name
          readOnly: true
        abbreviation:
          type: string
          title: Abbreviation
          readOnly: true
        alternative_names:
          items:
            type: string
          type: array
          title: Alternative Names
          readOnly: true
        firmware_count:
          type: integer
          title: Firmware Count
          readOnly: true
      type: object
      required:
      - id
      - slug
      - fs_slug
      - rom_count
      - name
      - igdb_slug
      - moby_slug
      - hltb_slug
      - libretro_slug
      - created_at
      - updated_at
      - fs_size_bytes
      - is_unidentified
      - is_identified
      - missing_from_fs
      - display_name
      - abbreviation
      - alternative_names
      - firmware_count
      title: PlatformSchema
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Body_add_platform_api_platforms_post:
      properties:
        fs_slug:
          type: string
          title: Fs Slug
          description: Platform slug.
      type: object
      required:
      - fs_slug
      title: Body_add_platform_api_platforms_post
    FirmwareSchema:
      properties:
        id:
          type: integer
          title: Id
        platform_id:
          type: integer
          title: Platform Id
        file_name:
          type: string
          title: File Name
        file_name_no_tags:
          type: string
          title: File Name No Tags
        file_name_no_ext:
          type: string
          title: File Name No Ext
        file_extension:
          type: string
          title: File Extension
        file_path:
          type: string
          title: File Path
        file_size_bytes:
          type: integer
          title: File Size Bytes
        full_path:
          type: string
          title: Full Path
        is_verified:
          type: boolean
          title: Is Verified
        crc_hash:
          type: string
          title: Crc Hash
        md5_hash:
          type: string
          title: Md5 Hash
        sha1_hash:
          type: string
          title: Sha1 Hash
        missing_from_fs:
          type: boolean
          title: Missing From Fs
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - platform_id
      - file_name
      - file_name_no_tags
      - file_name_no_ext
      - file_extension
      - file_path
      - file_size_bytes
      - full_path
      - is_verified
      - crc_hash
      - md5_hash
      - sha1_hash
      - missing_from_fs
      - created_at
      - updated_at
      title: FirmwareSchema
    Body_update_platform_api_platforms__id__put:
      properties:
        custom_name:
          anyOf:
          - type: string
            maxLength: 400
          - type: 'null'
          title: Custom Name
          description: Custom platform name.
        description:
          anyOf:
          - type: string
            maxLength: 65535
          - type: 'null'
          title: Description
          description: Custom platform description.
      type: object
      title: Body_update_platform_api_platforms__id__put
    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
  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