Skip to main content

The options of integrating a RSPS list into a RuneScape private server is usually limited to placing a voting button on a website, or setting up incentive voting through the callback system. At RuneLocus, we’re providing an API. The RuneLocus API gives servers the option to create custom integrations with RuneLocus.

Updating the Live Description

A Live Description replaces a server’s description on the RSPS list for 1 hour, and are much more noticeable due to their prominent bold font. A few common uses of Live Descriptions:

  • Last-minute promotion of an event that is occurring in a short while.
  • Promoting temporary giveaways for new registering players.
  • Announcing a new server update that has just taken place

Live Descriptions are set through the RuneLocus API. The API allows you to develop fully custom integrations with RuneLocus. Do you need some inspiration for Live Description integration for your your server? What about making an in-game command to set the Live Descriptions directly from your game?

::live We are starting a big Castle Wars event at 1PM CET. Everyone is welcome and will receive a special reward afterwards. Make sure to join Discord for more information!

Below, you’ll find the API documentation for updating your Live Description.

URL

copy

Method

POST

URL Params

Name

server_id

key

Value

int

string

Description

The ID of the server that needs to be updated.

The API key of the server. This is set in the server’s settings.

Additional

Required

Required

POST Params

Name

content

Value

string

Description

The content of the live description you wish to set (130 – 250 chars).

Additional

Required

Success Response

Code

200

Body

Copy

Error Response

Code

400

Body

Copy

This error occurs when the API Key parameter is missing in the URL.

Copy

This error occurs when the server ID parameter is missing in the URL.

Copy

This error occurs when no action was configured. To update a live description, make sure to use the correct URL format (shown on top of this documentation).

Copy

This error occurs when no content for the live description was set. Make sure to POST the content POST Parameter as explained above.

Copy

This error occurs when your live description’s character count is below 130, or above 250 characters.

401

Copy

This error occurs when an incorrect API key was provided. Make sure to use the same API key that you configured in your server’s settings.

404

Copy

This error occurs when an incorrect server ID was provided. You can find the correct server ID in your server overview in MyLocus.

429

Copy

This error occurs when you’re trying to set a new live description too often.

Sample Call (PHP)

Copy

Finding a vote

Even though the callback system for incentive voting should be enough, there might be a situation in which you’d want to double check whether your player has actually made a vote. Using this API endpoint, you can search within the votes your server has received.

URL

Copy

Method

GET

URL Params

Name

callback

server_id

key

Value

int

string

string

Description

The ID of the server that you’re trying to find vote records for.

The API key of the server. This is set in the server’s settings.

The contents of the callback parameter that your player used to vote with (depending on your server’s callback system, this can be a session id, username, IP address, etc.).

Additional

Required

Required

Required

Success Response

Code

200

Body

Copy

Error Response

Code

400

Body

Copy

This error occurs when the API Key parameter is missing in the URL.

Copy

This error occurs when the server ID parameter is missing in the URL.

Copy

This error occurs when no action was configured. To search for a vote, make sure to use the correct URL format (shown on top of this documentation).

401

Copy

This error occurs when an incorrect API key was provided. Make sure to use the same API key that you configured in your server’s settings.

404

Copy

This error occurs when an incorrect server ID was provided. You can find the correct server ID in your server overview in MyLocus.

Copy

This error occurs when the provided callback parameter does not exist in our records.

Sample Call (PHP)

Copy

Was this post helpful?

Iki

Close Menu

About RuneLocus

For 15 years, RuneLocus has been the leading platform for RuneScape private servers. The RSPS list has been used by thousands of servers, and hundreds of thousands of players.