If you'd like to link to Romhack Plaza on your various platforms, we've set up a public API.
This allows you to retrieve information about an entry, an author, a user, etc., as well as download links. It can also be used to obtain entries in relation to the CRC32 / SHA-1 of the ROM, useful for certain platforms such as Recalbox.
The URL is: https://romhackplaza.org/public_api/rhpz/v1/{endpoint}
To authenticate yourself, you'll need your e-mail address and the API key. You'll need to include the following string in your request header: {account e-mail}:{API key} (basic authentication).
You'll find detailed documentation of all endpoints in this forum. Threads are available below to ask questions about these endpoints.
On each request, you'll also have the following four fields:
If you have any ideas for new endpoints, please let me know so that I can add them if possible.
This allows you to retrieve information about an entry, an author, a user, etc., as well as download links. It can also be used to obtain entries in relation to the CRC32 / SHA-1 of the ROM, useful for certain platforms such as Recalbox.
The URL is: https://romhackplaza.org/public_api/rhpz/v1/{endpoint}
To authenticate yourself, you'll need your e-mail address and the API key. You'll need to include the following string in your request header: {account e-mail}:{API key} (basic authentication).
You'll find detailed documentation of all endpoints in this forum. Threads are available below to ask questions about these endpoints.
On each request, you'll also have the following four fields:
| Name | Type | Description |
|---|---|---|
| code | string | The code begin by 'rest_', may be ok, ko, not_found, forbidden, ... |
| message | string | Used if there is an error with the request |
| status | string | If the request is from the server, OK or KO |
| requested_id | string | The first field from the request, it's frequent this is an ID like an Entry ID |
If you have any ideas for new endpoints, please let me know so that I can add them if possible.
