NationStates API (nationdata/regiondata)

[PhilTech]

After I got the client key,what I should do with?

Where do you intend to use it exactly? Usually, it is used for recruiting purposes - API client/API automatic telegrammer.

Lucky for us, NS has some brilliant people and they already created API clients that are publicly available for the community.

Just choose one of them of your liking and you're now set. I recommend not using Nstg-web, I've tried it and has a lot of issues. I personally use pyNSrecruit.

[Frisbeeteria]

After I got the client key,what I should do with?

If you don't know how scripts work, you shouldn't be doing anything with it. API scripts are designed for people who who have a basic understanding of the concepts.

[Imperium Anglorum]

Removed GENSEC and HELD from the API since they're not ready for public consumption yet.

Could these be added back to the API?

Bump this request.

[Aurum Raider]

Would a World API endpoint that returns the most recent region updated be possible? (LASTREGION)
The main use would be for monitoring update progress during the update itself, as well as enhancing time prediction scripts.

[The United Penguin Commonwealth]

Is there an official or third-party forum API?

[Ever-Wandering Souls]

Is there an official or third-party forum API?

No, botted interaction with the forums is pretty heavily discouraged and not officially supported.

From the Scripting FAQ that Ziz and I are working on, with sourcing to [v]:

Q: Can my bot interact with the NS forums?
A: Any form of scraping is heavily discouraged, and it is forbidden for scripts to perform actions as logged in users or to attempt to log in.

[Imperium Anglorum]

Removed GENSEC and HELD from the API since they're not ready for public consumption yet.

Could these be added back to the API?

Bump this request again. It would be great to be able to add to the (my) proposal archive GenSec remarks on various proposals.

[United Calanworie]

Can we please get the SPDR score of each nation added to the daily dumps? It would avoid having to make dozens or hundreds of calls in order to check influence for all nations in a region.

[Vleerian]

Something that's been on the wishlist for a while, would it be possible to have LASTUPDATE include a timestamp for the minor update?

Presently to determine the exact length of the update, you can use the LASTUPDATE of the first and last regions. For the Major this data is present in the regions.xml data dump. For minor, you must make these requests on your own, and save the relevant data locally, as this data is overwritten over the course of the major update.

This would be especially valuable in the data dumps for tools like Spyglass which use LASTUPDATE to determine the length of the update, permitting it to calculate these values without relying on previous usage, or depending on an external resource to provide them.

My preference would be that the data is provided as an XML attribute a la

Code: Select all

<LASTUPDATE minor="(minor update time)">(major update time)</LASTUPDATE>


So as to be backwards compatible with existing tools that may be poorly (or not at all) maintained, while still providing the data under the LASTUPDATE tag.

[Ever-Wandering Souls]

Something that's been on the wishlist for a while, would it be possible to have LASTUPDATE include a timestamp for the minor update?

Presently to determine the exact length of the update, you can use the LASTUPDATE of the first and last regions. For the Major this data is present in the regions.xml data dump. For minor, you must make these requests on your own, and save the relevant data locally, as this data is overwritten over the course of the major update.

This would be especially valuable in the data dumps for tools like Spyglass which use LASTUPDATE to determine the length of the update, permitting it to calculate these values without relying on previous usage, or depending on an external resource to provide them.

My preference would be that the data is provided as an XML attribute a la

Code: Select all

<LASTUPDATE minor="(minor update time)">(major update time)</LASTUPDATE>


So as to be backwards compatible with existing tools that may be poorly (or not at all) maintained, while still providing the data under the LASTUPDATE tag.

I'll also add that while a lot of users would vastly prefer getting this info regionally (whether in one, larger lastupdate shard or new shards), if this is not something you're willing to implement, it would also be similarly-but-less helpful to have an "updatelength" shard with the timestamp for either the end or the total runtime of /both/ of the last updates (again whether in one combined or two shards)

[Refuge Isle]

Might a banner shard be added to the region API?

[Sweeze]

hihi- being that RO appoint timestamps are already included on the general region shard, any possibility we could get delegate elect timestamps on the region shard as well? i hate the idea of scraping the html for that info

[Imperium Anglorum]

Could these be added back to the API?

Bump this request again. It would be great to be able to add to the (my) proposal archive GenSec remarks on various proposals.

Bump this again. There was recently a proposal which expired within hours of being held. And because proposals are deleted when they expire, there was no way for me (or others) to recover the GenSec statements on the matter or who voted. Adding them to the API would allow for that information to be archived.

[United Calanworie]

Can we please get the SPDR score of each nation added to the daily dumps? It would avoid having to make dozens or hundreds of calls in order to check influence for all nations in a region.

Something that's been on the wishlist for a while, would it be possible to have LASTUPDATE include a timestamp for the minor update?

Presently to determine the exact length of the update, you can use the LASTUPDATE of the first and last regions. For the Major this data is present in the regions.xml data dump. For minor, you must make these requests on your own, and save the relevant data locally, as this data is overwritten over the course of the major update.

This would be especially valuable in the data dumps for tools like Spyglass which use LASTUPDATE to determine the length of the update, permitting it to calculate these values without relying on previous usage, or depending on an external resource to provide them.

My preference would be that the data is provided as an XML attribute a la

Code: Select all

<LASTUPDATE minor="(minor update time)">(major update time)</LASTUPDATE>


So as to be backwards compatible with existing tools that may be poorly (or not at all) maintained, while still providing the data under the LASTUPDATE tag.

Bumping both of these as they'd be real nice to have available.

[Hagston]

I'm not sure if this is the right place, but does anyone know why my client key has stopped being recognized? For awhile now, everytime I try to use this TG tool (https://auralia.github.io/nstg-web/build/), it comes up with "Client Not Registered For API". I went and tried a new api template, and was then asked to make an API request for it. I clicked on the provided link, but the same message cam up again.

It all used to work fine. But now suddenly it doesn't? Do they expire or something?

[Comfed]

I'm not sure if this is the right place, but does anyone know why my client key has stopped being recognized? For awhile now, everytime I try to use this TG tool (https://auralia.github.io/nstg-web/build/), it comes up with "Client Not Registered For API". I went and tried a new api template, and was then asked to make an API request for it. I clicked on the provided link, but the same message cam up again.

It all used to work fine. But now suddenly it doesn't? Do they expire or something?

You should probably file a GHR to ask that question.

Alternatively, the tool may be broken.

[[violet]]

Could these be added back to the API?

Bump this request again. It would be great to be able to add to the (my) proposal archive GenSec remarks on various proposals.

I'm back and doing API stuff. Added.

[East Durthang]

An endpoint which spits out all the issues in the game and what options are available to select for each would be lovely. Bonus points if it also includes other metrics about the issues such as author (if there is one), prerequisites, number of nations who have picked each option, and so on.

[[violet]]

Might a banner shard be added to the region API?

Added BANNER to Standard Region API and BANNER and BANNERBY as Region API shards.

[SherpDaWerp]

An endpoint which spits out all the issues in the game and what options are available to select for each would be lovely. Bonus points if it also includes other metrics about the issues such as author (if there is one), prerequisites, number of nations who have picked each option, and so on.

Counterpoint: don't. The spoiler thread exists for this exact purpose; NS providing on-demand info for all of this would completely ruin the fun.

[Comfed]

An endpoint which spits out all the issues in the game and what options are available to select for each would be lovely. Bonus points if it also includes other metrics about the issues such as author (if there is one), prerequisites, number of nations who have picked each option, and so on.

Counterpoint: don't. The spoiler thread exists for this exact purpose; NS providing on-demand info for all of this would completely ruin the fun.

What fun? There is already a website with all the issues results, and if you don't want spoilers for your issues... don't look for them?

[[violet]]

An endpoint which spits out all the issues in the game and what options are available to select for each would be lovely. Bonus points if it also includes other metrics about the issues such as author (if there is one), prerequisites, number of nations who have picked each option, and so on.

Counterpoint: don't. The spoiler thread exists for this exact purpose; NS providing on-demand info for all of this would completely ruin the fun.

We probably won't ever serve data on NS internals such as number of issues in existence, what options those issues have, etc. We will serve data on the state of things in the game world, e.g. nations, regions.

[Imperium Anglorum]

Bump this request again. It would be great to be able to add to the (my) proposal archive GenSec remarks on various proposals.

I'm back and doing API stuff. Added.

Thanks! I've also done some coding on my side to archive those remarks.

[SherpDaWerp]

Counterpoint: don't. The spoiler thread exists for this exact purpose; NS providing on-demand info for all of this would completely ruin the fun.

What fun? There is already a website with all the issues results, and if you don't want spoilers for your issues... don't look for them?

..a website that is provided thanks to the efforts of player(s) (not staff: Trotterdam and those who've provided effect lines for him to track), and isn't guaranteed to be accurate (the way a NS API call would be). Trotterdam's tool is much closer to the spoiler thread in design than an API endpoint would be.

There's a world of difference between players maintaining potentially-accurate spoiler resources and NS just giving us the information whenever we ask.

[Refuge Isle]

Might a banner shard be added to the region API?

Added BANNER to Standard Region API and BANNER and BANNERBY as Region API shards.

Thanks! This will be a great help