Ikzann: add details

2024-10-26T15:06:08Z

add details

@@ Line 1: / Line 1: @@
 Any relay script that injects client-side JavaScript code into the relay browser can get access to Mafia data by making an HTTP request to the <code>/KoLmafia/jsonApi</code> endpoint. Requests should be x-www-urlencoded with <code>pwd=[hash]</code> and <code>body=[json object]</code>.
 The JSON request object has the type <code>{ properties?: string[], functions?: { name: string, args: unknown[] }[] }</code>. Names of functions are in JS style (camelCase).
@@ Line 8: / Line 10: @@
 Details for an enumerated type instance can be requested with the special <code>identity</code> function, which can take placeholder arguments and return the full object.

Ikzann: create browser json page

2024-10-26T14:58:46Z

create browser json page

New page

Any relay script that injects client-side JavaScript code into the relay browser can get access to Mafia data by making an HTTP request to the <code>/KoLmafia/jsonApi</code> endpoint. Requests should be x-www-urlencoded with <code>pwd=[hash]</code> and <code>body=[json object]</code>.

The JSON request object has the type <code>{ properties?: string[], functions?: { name: string, args: unknown[] }[] }</code>. Names of functions are in JS style (camelCase).

The response will have type <code>{ error: string }</code> or <code>{ properties?: string[], functions?: unknown[] }</code>, with <code>properties</code> and <code>functions</code> each present if they were present on the request object. The ordering of each of <code>properties</code> and <code>functions</code> will correspond to the request ordering.

Enumerated types (Item, Familiar, Modifier, etc.) can be passed in with either of the following placeholder formats: <code>{ objectType: EnumeratedTypeName, identifierString: string } | { objectType: EnumeratedTypeName, identifierNumber: number }</code>. If both <code>identifierString</code> and <code>identifierNumber</code> are present, <code>identifierNumber</code> will be prioritized. Enumerated types will be returned as a POJO with all the fields of a JS enumerated type, with field names in camelCase, except any second-level referenced objects will be left as placeholders. Objects will also have the placeholder fields (<code>objectType</code>, <code>identifierString</code>, <code>identifierNumber</code> if applicable) set.

Details for an enumerated type instance can be requested with the special <code>identity</code> function, which can take placeholder arguments and return the full object.

Browser JSON API - Revision history

Ikzann: add details

Ikzann: create browser json page