Explore the API

Current API Version

1.0

Daily Query Limit

100

The WikiRumours API allows authorized users to retrieve WikiRumours data asynchronously for use in their own applications. The API is a continual work in progress, so as new versions of the API become available, old versions will be retired (after a suitable transition period). If you notice that your API calls have stopped returning data, please check the returned status messages to ensure that your API URL hasn't become deprecated.

In general, sub-incremental versions are forwards-compatible (e.g. v1.2 will accept the same parameters as v1.1), but incremental versions will not (e.g. v2 will require different configuration than v1).

Accessing the WikiRumours API requires a private, unique, user-specific access key. You can obtain a key through your profile / account settings. Please keep this key secure (e.g. do not add it to browser-viewable code).

A query limit is enforced on the WikiRumours API to ensure appropriate access by all users. For special applications, please let us know.

API Parameters


GET Retrieve a Report

HEADERS
api-key {{api_key}}
username {{username}}

GET Retrieve Report Sightings

HEADERS
api-key {{api_key}}
username {{username}}

GET List Reports

HEADERS
api-key {{api_key}}
username {{username}}
PARAMS
page {{#}}

POST Create a Report

HEADERS
api-key {{api_key}}
username {{username}}
BODY formdata
title TEXT
country 2-character ISO code
report_location LAT, LONG
occurred_on DATETIME
source Match server options
sighting_country 2-character ISO code
overheard_at Match server options
heard_on DATETIME
sighting_location LAT, LONG
tags Comma separated tag values

POST Create Sighting

HEADERS
api-key {{api_key}}
username {{username}}
BODY formdata
source Match server options
country 2-character ISO code
overheard_at Match server options
heard_on DATETIME
report Report ID number
location LAT, LONG

PUT Edit a Report

HEADERS
api-key {{api_key}}
username {{username}}
BODY formdata
title TEXT
country 2-character ISO code
report_location LAT, LONG
occurred_on DATETIME
source Match server options
sighting_country 2-character ISO code
overheard_at Match server options
heard_on DATETIME
sighting_location LAT, LONG
tags Comma separated tag values

PUT Edit a Sighting

HEADERS
api-key {{api_key}}
username {{username}}
BODY formdata
source Match server options
country 2-character ISO code
overheard_at Match server options
heard_on DATETIME
report Report ID number
location LAT, LONG

Error Handling

Incorrectly configured input parameters will result in an error being returned with the data. If the proper output format parameter cannot be determined, the default output for error messages is XML.