OpenRaid

Forums

You have private messages. Click to view them. You can access the forum via 'Board index'. See 'OpenRaid/My Account/Preferences' to change this behaviour.

OpenRaid API

DISCLAIMER:
This service comes without warranty of any kind. We reserve the right to close, revoke or disable any API key at any time, for any reason, and do not need to disclose this to anyone. There is no guarantee that this service is fit for any particular purpose and we do not guarantee any quality of service, uptime, valid responses, timely responses or anything else. Damage caused directly or indirectly by using this service is at own risk and we cannot be held responsible.

What can I use this for? What about API keys?

You can use the OpenRaid API any way you like. We grant a "demo" key for development purposes. Please note that this key can be changed at any time. If you use any code in any production environment, app or other software, please request your own API key by e-mailing admin@openraid.org! If you have any issues, please use that e-mail address as well. The demo key can be found below.

Demo key

The demo key that is currently usable is: BlmRPGilOwu3zDZN

Basic Usage & Security

There are private and public API's that you may use. The private API's require a security token provided by us (more information below). We will start by showing you how the public API's work first, because those are easier.

Any API will return JSON data. Example outputs are given for each command. All arguments are mandatory unless otherwise specified. The base URL you can use is: https://openraid.zergid.com/data/



Public API's

Command Arguments Description
events keyword: any location name Returns an array of events/raids
eventfeed region: Either 'eu' or 'us'
role: Damage, Tank or Healer
ilvl: Numeric itemlevel of user
Returns an array of events suitable for the specified arguments
guildevents guild ID: any guild ID (find this in the URL on your guild page) Returns an array of events/raids linked to this guild
groupevents group ID: any group ID (find this in the URL on your group page) Returns an array of events/raids linked to this group



Private API's

These API's require a security token. See the login feature for information. Examples are not provided as you have to be logged in yourself. (you can easily construct examples to get the output format)

Command Arguments Description
login email address: a valid email address
password: the password Do not store! Use SSL!
API key: a valid API key, use BlmRPGilOwu3zDZN for development only
Returns a token. Store this and use it in the next requests.
characters token: a valid security token, see the login function Returns an array of characters this account owns
character token: a valid security token, see the login function
character ID: a valid character ID, see characers
Returns an array with information about the character
allraids token: a valid security token, see the login function Returns an array with all events the user can attend
friendraids token: a valid security token, see the login function Returns an array with all events the user can attend that friends are attending
myraids token: a valid security token, see the login function Returns an array with all events the user has signed up for
raidinfo token: a valid security token, see the login function
event ID: a valid event ID, see any other event API
Returns an array with information about the raid/event
save token: a valid security token, see the login function
event ID: a valid raid/event ID
sign status: can be: Maybe, Yes! (including exclamation mark) or No
character name: exact character name that is signing
role: Damage, Tank or Healer
comment optional: a sign-up comment
Returns an array with information about the character
addcomment token: a valid security token, see the login function
event ID: a valid raid/event ID
comment: a comment for that event
Returns an array with information about the character



Need more? Need help? Need an "official" API key?

Please get in touch with admin@openraid.org for more information.