Difference between revisions of "Rival Regions API"
From Rival Regions Wiki
| (10 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Some basic info on Rival Regions API. | Some basic info on Rival Regions API. | ||
| − | URL: https://rivalregions.com/ | + | URL: |
| + | {| class="wikitable" border="1" | ||
| + | |https://api.rivalregions.com/client/v1 | ||
| + | |} | ||
| − | ==== /getBuildigsNeeded | + | Authorisation is done with a header: |
| + | {| class="wikitable" border="1" | ||
| + | |Authorization: Bearer API_KEY | ||
| + | |} | ||
| + | |||
| + | You can get your API_KEY by contacting wm@rivalregions.com | ||
| + | |||
| + | You can also specify a server in a GET parameter for any API request: | ||
| + | |||
| + | '''?server=[main / tr]''' - optional parameter, defaults to main | ||
| + | |||
| + | === /getBuildigsNeeded === | ||
Returns the minimum building level for each Index. | Returns the minimum building level for each Index. | ||
| − | + | === /getRegions === | |
Returns basic info about all the regions. | Returns basic info about all the regions. | ||
| − | + | === /getDepartmentsLog === | |
Returns list of players who worked in the departments. | Returns list of players who worked in the departments. | ||
| + | |||
'''?start=[int]''' - optional parameter, defaults to [Unix Time Stamp]-24*3600 | '''?start=[int]''' - optional parameter, defaults to [Unix Time Stamp]-24*3600 | ||
| + | |||
| + | '''?stateId=[int]''' - optional parameter | ||
| + | |||
| + | '''?depId=[int]''' - optional parameter | ||
| + | |||
| + | === /getUsers === | ||
| + | Returns players according to one of the provided parameter: | ||
| + | |||
| + | '''?regionId=[int]''' | ||
| + | |||
| + | '''?stateId=[int]''' | ||
| + | |||
| + | '''?regionResidencyId=[int]''' | ||
| + | |||
| + | '''?stateResidencyId=[int]''' | ||
| + | |||
| + | '''?partyId=[int]''' | ||
| + | |||
| + | '''?userId=[int]''' | ||
Latest revision as of 10:26, 16 September 2022
Some basic info on Rival Regions API. URL:
| https://api.rivalregions.com/client/v1 |
Authorisation is done with a header:
| Authorization: Bearer API_KEY |
You can get your API_KEY by contacting wm@rivalregions.com
You can also specify a server in a GET parameter for any API request:
?server=[main / tr] - optional parameter, defaults to main
/getBuildigsNeeded
Returns the minimum building level for each Index.
/getRegions
Returns basic info about all the regions.
/getDepartmentsLog
Returns list of players who worked in the departments.
?start=[int] - optional parameter, defaults to [Unix Time Stamp]-24*3600
?stateId=[int] - optional parameter
?depId=[int] - optional parameter
/getUsers
Returns players according to one of the provided parameter:
?regionId=[int]
?stateId=[int]
?regionResidencyId=[int]
?stateResidencyId=[int]
?partyId=[int]
?userId=[int]
