NationStates API (nationdata/regiondata)

[SherpDaWerp]

Can I request a shard that says how much bank a nation has?
It would make management of my farm much easier - I could check how much bank they have without looking through them all.

[[violet]]

These two files

Oh wow, I didn't even realize such a thing existed. Now I understand what some other people were talking about as well!

I'll add it to the doc.

[[violet]]

Can I request a shard that says how much bank a nation has?

Added! Documented under "Deck Owner Info."

[SherpDaWerp]

Can I request a shard that says how much bank a nation has?

Added! Documented under "Deck Owner Info."

Amazing, thanks heaps!

[SherpDaWerp]

Gee, I'm way too keen for shiny new features...

Bit of a complicated one, this one. Would it be possible for there to be a way to view the number of unopened card packs a nation has? Not opening them, AFAIK that's been ruled illegal, just checking how many card packs are there.

Given that that information doesn't show up without being logged in, I assume for such a shard there would need to be an authentication process involved, which would make it a bit more annoying than other, publicly-accessible shards.

(If it helps, my end goal here is to have a script that queries all of my puppets and tells me which ones need manual attention - i.e. those with enough bank for me to consider a puppet transfer and those that have lots of unopened card packs. This would mean my "farming" process becomes more streamlined as I can just manually answer issues and then run the script once I'm done, instead of checking cards for every puppet while I'm logged in.)

Thanks again for making this accessible, it's great!

[Darcania]

Loving the card API so far, thank you for implementing it and letting devs play around with the beta.
Probably the most major request from me would be to be able to ask for a card by a specified nation name rather than card ID. For instance, rather than querying for "?q=card+info;cardid=1;season=1", I'd like it if there were an option to query via "?q=card+info;cardname=testlandia;season=1" or similar.

Edit: Also, for the Deck Owner Info shard, would it be possible to also receive information on WA Census 86 along with it, namely rankings? And would it be possible to return the deck owner's nation name as well, for when a nation's ID is passed?

[Darcania]

Slight bug that Praeceps found: <DECK_SIZE> doesn't take into account whether a nation has PMG, and thus reports inaccurate numbers for PMG nations.
Also, not a bug, but DECK_SIZE is a little misleading... it's the deck's capacity, not its actual size.

[[violet]]

Would it be possible for there to be a way to view the number of unopened card packs a nation has?

This is now available as the Private Nation Shard "packs".

As you mention, it requires authentication.

[[violet]]

Also, for the Deck Owner Info shard, would it be possible to also receive information on WA Census 86 along with it, namely rankings? And would it be possible to return the deck owner's nation name as well, for when a nation's ID is passed?

I've added both of these.

Loving the card API so far, thank you for implementing it and letting devs play around with the beta.
Probably the most major request from me would be to be able to ask for a card by a specified nation name rather than card ID. For instance, rather than querying for "?q=card+info;cardid=1;season=1", I'd like it if there were an option to query via "?q=card+info;cardname=testlandia;season=1" or similar.

Unfortunately this isn't possible to add without slowing down the Cards API, since it would require loading a nation.

[[violet]]

Slight bug that Praeceps found: <DECK_SIZE> doesn't take into account whether a nation has PMG, and thus reports inaccurate numbers for PMG nations.
Also, not a bug, but DECK_SIZE is a little misleading... it's the deck's capacity, not its actual size.

Renamed to DECK_CAPACITY_RAW. Unfortunately it won't report the true deck size since that would require loading a nation to check the account status.

[SherpDaWerp]

Would it be possible for there to be a way to view the number of unopened card packs a nation has?

This is now available as the Private Nation Shard "packs".

As you mention, it requires authentication.

Praise Violet! Thanks!

[[violet]]

PSA: I am planning to remove the <CARDCATEGORY> field from Nation Daily Dump files as well as the undocumented Public Nation Shard, since:

• it's now available via the Cards API as well as Ballotonia's Trading Cards Daily Dump files
• it describes an unchanging value
• it's super inefficient

[Flanderlion]

Probably the most major request from me would be to be able to ask for a card by a specified nation name rather than card ID. For instance, rather than querying for "?q=card+info;cardid=1;season=1", I'd like it if there were an option to query via "?q=card+info;cardname=testlandia;season=1" or similar.

Could you not just use: https://www.nationstates.net/cgi-bin/ap ... ion&q=dbid and then use the number in the request? Would take you 2 requests though.

[Darcania]

Thank you, [v]

Could you not just use: https://www.nationstates.net/cgi-bin/ap ... ion&q=dbid and then use the number in the request? Would take you 2 requests though.

That is what I'm currently doing, and I cache and store the results as well. It was simply a feature request to see if a shortcut API-side was possible, which it is not, so I will continue with my current approach.

[[violet]]

Starting next update, <DBID> will be included in the Nations Daily Dump, since it's an unchanging value that you might want to fetch for a lot of nations.

[Darcania]

Would it be possible to add a DECK_COUNT or some sort for the Deck Owner Info shard, to show how many cards a nation owns without having to load the Decks shard and counting each CARD element? Since some nations have quite a lot of cards, it can slow things down by just a bit to load and count each card.

[[violet]]

Would it be possible to add a DECK_COUNT or some sort for the Deck Owner Info shard, to show how many cards a nation owns without having to load the Decks shard and counting each CARD element?

Yep! Added as <NUM_CARDS>.

[The Northern Light]

Request

In this thread, [violet] mentioned that they'd be open to adding an API option for gifting cards. I wanted to bring this up here as an actual request, and see whether it'd be possible for an option to gift a card to be added to the private nation API.

As discussed in the above-mentioned thread, The North Pacific very actively gifts cards, as part of various promotional and cultural events (examples: 1, 2, 3, 4, 5, 6). We have at least three daily giveaways, plus several one-off events, for a total of more than 2500 high-value gifted cards. Unfortunately, maintaining all of these manually is very tedious, and being able to automated through the API would be very helpful.

Thanks in advance!

[[violet]]

an API option for gifting cards

What would be a reasonable rate, i.e. how many cards per day do you want to gift?

[[violet]]

Gifting cards is now supported via API! Documentation is under Nation Private Commands.

[9003]

I would love to request a collection management function in the API.

Even if it has to be a slower rate anything that allows it to be automatic would be amazing for people who do large collections for example
Every TNP card or every TWP or every common card

[Ferranghia]

Greetings.

I would like to write a script that regularly (read, once daily) gets the full census for my nation via the API and on a regular interval (say, the second of every month) posts a templated bulletin in my nation's dispatches highlighting the highest differences since last month, the best performing areas, etc.
Are there any plans of making an endpoint to create dispatches via the API, or do I have to go the HTML script way in order to do that?

[Agadar]

Are there any plans of making an endpoint to create dispatches via the API, or do I have to go the HTML script way in order to do that?

The latter is definitely not allowed.

[Trotterdam]

The latter is definitely not allowed.

Says where? There is a list of restricted actions that may not be scripted using the HTML site, and creating or editing a dispatch is not among them (since it only affects your own nation and not anything else in the game world).

[Ferranghia]

Are there any plans of making an endpoint to create dispatches via the API, or do I have to go the HTML script way in order to do that?

The latter is definitely not allowed.

How so? The only rule that I think this may be borderlining would be this

anything that generates a Happenings event line in a region, the World Assembly, or a nation other than your own

based on the fact that my nation is in a region that was not founded by me.

Having my bot generate the content for the bullettin and then manually posting it wouldn't be that much of a hassle anyway, it would just be one more inconvenience every month