RomM Search API
The search API from RomM — 2 operation(s) for search.
The search API from RomM — 2 operation(s) for search.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/romm:romm-search-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: RomM Search API
version: 5.4.0
tags:
- name: Search
paths:
/api/search/roms:
get:
tags:
- Search
summary: Search Rom
description: 'Search for rom in metadata providers
Args:
request (Request): FastAPI request
rom_id (int): Rom ID
source (str): Source of the rom
search_term (str, optional): Search term. Defaults to None.
search_by (str, optional): Search by name or ID. Defaults to "name".
search_extended (bool, optional): Search extended info. Defaults to False.
Returns:
list[SearchRomSchema]: List of matched roms'
operationId: search_rom_api_search_roms_get
security:
- OAuth2PasswordBearer:
- roms.read
- HTTPBasic: []
parameters:
- name: rom_id
in: query
required: true
schema:
type: integer
title: Rom Id
- name: search_term
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search Term
- name: search_by
in: query
required: false
schema:
type: string
default: name
title: Search By
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SearchRomSchema'
title: Response Search Rom Api Search Roms Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/search/cover:
get:
tags:
- Search
summary: Search Cover
description: Search the cover art providers, in the configured cover priority order.
operationId: search_cover_api_search_cover_get
security:
- OAuth2PasswordBearer:
- roms.read
- HTTPBasic: []
parameters:
- name: search_term
in: query
required: false
schema:
type: string
default: ''
title: Search Term
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SearchCoverSchema'
title: Response Search Cover Api Search Cover Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
SearchCoverSchema:
properties:
provider:
type: string
enum:
- sgdb
- steam
title: Provider
name:
type: string
title: Name
resources:
items:
$ref: '#/components/schemas/CoverResource'
type: array
title: Resources
type: object
required:
- provider
- name
- resources
title: SearchCoverSchema
CoverResource:
properties:
thumb:
type: string
title: Thumb
url:
type: string
title: Url
type:
type: string
title: Type
width:
type: integer
title: Width
height:
type: integer
title: Height
style:
type: string
title: Style
author:
type: string
title: Author
score:
type: integer
title: Score
nsfw:
type: boolean
title: Nsfw
humor:
type: boolean
title: Humor
epilepsy:
type: boolean
title: Epilepsy
type: object
required:
- thumb
- url
- type
- width
- height
- style
- author
- score
- nsfw
- humor
- epilepsy
title: CoverResource
description: 'One piece of artwork the manual cover search offers, in the shape
SteamGridDB grids have, so every provider fills the same picker.'
SearchRomSchema:
properties:
id:
anyOf:
- type: integer
- type: 'null'
title: Id
igdb_id:
anyOf:
- type: integer
- type: 'null'
title: Igdb Id
moby_id:
anyOf:
- type: integer
- type: 'null'
title: Moby Id
ss_id:
anyOf:
- type: integer
- type: 'null'
title: Ss Id
sgdb_id:
anyOf:
- type: integer
- type: 'null'
title: Sgdb Id
flashpoint_id:
anyOf:
- type: string
- type: 'null'
title: Flashpoint Id
launchbox_id:
anyOf:
- type: integer
- type: 'null'
title: Launchbox Id
demozoo_id:
anyOf:
- type: integer
- type: 'null'
title: Demozoo Id
steam_id:
anyOf:
- type: integer
- type: 'null'
title: Steam Id
libretro_id:
anyOf:
- type: string
- type: 'null'
title: Libretro Id
platform_id:
type: integer
title: Platform Id
name:
type: string
title: Name
slug:
type: string
title: Slug
default: ''
summary:
type: string
title: Summary
default: ''
igdb_url_cover:
type: string
title: Igdb Url Cover
default: ''
moby_url_cover:
type: string
title: Moby Url Cover
default: ''
ss_url_cover:
type: string
title: Ss Url Cover
default: ''
sgdb_url_cover:
type: string
title: Sgdb Url Cover
default: ''
flashpoint_url_cover:
type: string
title: Flashpoint Url Cover
default: ''
launchbox_url_cover:
type: string
title: Launchbox Url Cover
default: ''
demozoo_url_cover:
type: string
title: Demozoo Url Cover
default: ''
steam_url_cover:
type: string
title: Steam Url Cover
default: ''
libretro_url_cover:
type: string
title: Libretro Url Cover
default: ''
is_unidentified:
type: boolean
title: Is Unidentified
is_identified:
type: boolean
title: Is Identified
type: object
required:
- platform_id
- name
- is_unidentified
- is_identified
title: SearchRomSchema
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