Namespace: types

types

Type definitions of objects returned by NationScript.

Type Definitions

Auction

Represents an ongoing auction on a card.

Type:
  • object
Properties:
Name Type Description
id number

ID of the card being auctioned.
rarity string

Rarity of the card.
nation string

Nation depicted on the card (Proper Form).
season number

ID of the season the card was inscribed for.

Banner

Represents a national banner.

Type:
  • object
Properties:
Name Type Description
id string

ID of the banner.
name string

Full name of the banner.
condition string

Vague description of the banner's unlock condition.

Card

Represents a trading card in the NationStates multiverse, holding all the data requested from the Cards API.

Type:
  • object
Properties:
Name Type Attributes Description
id number

Card ID; corresponds to the depicted nation's dbID.
season number

ID of the season the card was inscribed for.
value number

Market value of the card, calculated by the game.
rarity string

The card's Rarity.
depicted CardNation <optional>

Details of the nation depicted on the card.
owners Array.<string> <optional>

Names of nations owning a copy of the card (id_form). The number of times a nation appears corresponds to the number of copies that nation owns.
asksBids Array.<Market> <optional>

Extant Asks and Bids ("Markets").
trades Array.<TradeCardbound> <optional>

Transfers of the card that matched the query filter.

CardBadge

Represents a commendation, condemnation, liberation, or injunction badge displayed on a nation or region.

Type:
  • object
Properties:
Name Type Description
type string

CardBadgeType of the badge.
data number

For Commendation/Condemnation badges, the ID of the instituting SC resolution. For authorship and easter egg badges, the count of authorships/easter eggs found. For others, 1.

CardNation

Represents a nation depicted on a Card.

Type:
  • object
Properties:
Name Type Description
name string

Nation name (Proper Form).
motto string

National motto.
pretitle string

National pretitle.
region string

Region the nation resides in (Proper Form).
category string

World Census classification of the nation, e.g. New York Times Democracy.
flag string

URL of the nation's flag image file, relative to https://www.nationstates.net/images/cards/sX/, where X is the season of the card the depiction is on.

CardWorld

Represents the wider card world of the NationStates multiverse, containing all the data requested from the Card API.

Type:
  • object
Properties:
Name Type Attributes Description
auctions Array.<Auction> <optional>

Auctions currently going on.
collectionDetail Collection <optional>

The queried collection.
collections Array.<ListCollection> <optional>

Collections owned by the queried nation.
cards Array.<ListCard> <optional>

Cards in the deck of the queried nation.
deckSummary Deck <optional>

Summary of the queried nation's deck.
trades Array.<Trade> <optional>

Trades matching the query filter.

CensusDataNation

Container object for data on a nation's performance on a World Census scale.

Type:
  • object
Properties:
Name Type Description
id number

CensusScale the rank is for.
score number

Raw score.
rankRegion number

Rank within the region.
rankRegionPercent number

Percentile within the region.
rankWorld number

Rank world-wide.
rankWorldPercent number

Percentile world-wide.

CensusDataRegion

Container object for data on a region's performance on a World Census scale, depending on its residents' scores on it.

Type:
  • object
Properties:
Name Type Description
id number

CensusScale the rank is for.
average number

Average score of the region's residents on the scale.
rank number

Rank of the region on the scale.
rankPercent number

Percentile of the region on the scale.

CensusDescription

Container object for census scale descriptions.

Type:
  • object
Properties:
Name Type Description
id number

CensusScale ID.
national string

Description of the scale's national rankings.
regional string

Description of the scale's regional rankings.

CensusRankScored

Container object for a nation's rank on a given World Census scale, including the raw score, as returned by the RegionShard.CENSUS_RANKS and WorldShard.CENSUS_RANKS shards.

Type:
  • object
Properties:
Name Type Description
nation string

Name of the nation (id_form).
rank number

Rank of the nation on the scale.
score number

Score of the nation on the scale.

CensusRankUnscored

Container object holding data on a nation's rank on the day's featured World Census scale, without the raw score, as returned by the NationShard.CENSUS_RANK_REGION and NationShard.CENSUS_RANK shards.

Type:
  • object
Properties:
Name Type Description
scale number

CensusScale the rank is for.
rank number

The rank of the nation.

Collection

Represents a collection of cards, in detailed form.

Type:
  • object
Properties:
Name Type Description
name string

Name of the collection.
owner string

Nation that created the collection (id_form).
edited number

Timestamp of the last change to the collection.
cards Array.<ListCard>

List of cards in the collection.

DeathData

Represents a cause of death with its prevalence in a nation.

Type:
  • object
Properties:
Name Type Description
cause string

DeathCause the data describes.
percent number

Percentage of deaths in the nation due to the cause.

Deck

Represents a nation's deck of trading cards.

Type:
  • object
Properties:
Name Type Description
nationID number

Database ID of the nation that owns the deck.
nationName string

Name of the nation that owns the deck (id_form).
bank number

Amount of bank the deck owner currently has.
capacity number

Maximum number of cards that may be in the deck.
numCards number

Number of cards currently in the deck.
value number

Total market value of all cards currently in the deck.
valueTime number

Timestamp of when the deck's value was assessed.
rank number

World-wide rank of the deck according to value.
rankRegion number

Region-wide rank of the deck according to value.
lastPack number

Timestamp of when the deck owner last opened a pack of cards.

DelegateActiveVote

Represents an extant vote cast by a WA delegate on an at-vote resolution.

Type:
  • object
Properties:
Name Type Description
delegate string

Name of the delegate (id_form).
weight number

Number of votes the delegate currently has.
timestamp number

Timestamp of when the vote was cast.

DelegateLogVote

Represents a vote historically cast by a WA delegate on an at-vote resolution. It may be the current vote, or have been updated since.

Type:
  • object
Properties:
Name Type Description
delegate string

Name of the delegate (id_form).
vote string

WAVote cast by the delegate.
weight number

Number of votes the delegate currently has.
timestamp number

Timestamp of when the vote was cast.

Dispatch

Represents a dispatch.

Type:
  • object
Properties:
Name Type Description
id number

ID of the dispatch.
title string

The dispatch's title.
author string

Nation that published the dispatch (id_form).
categoryTop string

DispatchCategory of the dispatch.
categorySub string

DispatchSubcategory of the dispatch.
body string

Body text of the dispatch.
posted number

Timestamp of the dispatch's original publication.
edited number

Timestamp of the last edit to the dispatch. If there haven't been any edits, 0.
views number

Number of views on the dispatch.
score number

The dispatch's score - upvotes minus downvotes.

DumpCard

Represents a trading card in the NationStates multiverse, containing all the data saved for the card in the requested season's one-off Dump.

Type:
  • object
Properties:
Name Type Description
id number

Card ID; corresponds to the depicted nation's dbID.
depicted CardNation

Details of the nation depicted on the card.
rarity string

The card's Rarity.
trophies Array.<Trophy>

Displayed World Census ranking trophies.
badges Array.<CardBadge>

Displayed miscellaneous badges.
description string

Industry and population info.

DumpNation

Represents a nation in the NationStates multiverse, containing all the data saved for the nation in the requested Daily Dump.

Type:
  • object
Properties:
Name Type Description
name string

Name of the nation (Proper Form).
pretitle string

National pretitle.
nameFull string

Full name of the nation (Proper Form).
motto string

National motto.
category string

World Census category of the nation, e.g. New York Times Democracy.
waStatus string

WAStatus of the nation.
endorsements Array.<string>

Nations endorsing this nation (id_form).
issuesAnswered number

Number of issues the nation has answered.
freedomDescriptions FreedomsTextData

Textual descriptions of the freedom levels in the nation.
region string

Region the nation resides in (Proper Form).
population number

Number of citizens the nation has, in millions.
tax number

Average income tax rate in the nation.
animal string

National animal of the nation.
currency string

Name of the nation's currency.
demonymAdjective string

The adjective demonym for the nation.
demonymNoun string

The singluar noun demonym for the nation.
demonymPlural string

The plural noun demonym for the nation.
flag string

Absolute URL of the national flag image file.
majorIndustry string

Largest industry in the nation.
spendingPriority string

Single largest field within the nation's expenditure.
expenditure SpendingData

Details of national government expenditure.
founded string

Textual description of when the nation was founded, relative to now.
firstLogin number

Timestamp of the nation's first login.
lastLogin string

Textual description of the time of the nation's last login, relative to now.
lastLoginTimestamp number

Timestamp of the nation's last login.
influence string

Influence the nation has in its region.
freedomScores FreedomsScoreData

Scores for the freedom levels in the nation.
gdpGovernment number

Percentage of the nation's GDP that is generated directly by government action.
deaths DeathData

Details on the causes of death in the nation.
leader string

Name of the national leader.
capital string

Name of the national capital.
religion string

Name of the national religion.
factbookNum number

Number of extant factbooks the nation authored.
dispatchNum number

Number of extant dispatches the nation wrote.
dbID number

Database ID of the nation.

DumpRegion

Represents a region in the NationStates multiverse, containing all the data saved for the region in the requested Daily Dump.

Type:
  • object
Properties:
Name Type Attributes Description
bannerID string <nullable>

ID of the regional banner. If the region doesn't fly a custom banner, null.
bannerURL string

Relative URL of the regional banner image file.
delegateName string <nullable>

Nation serving as the regional WA Delegate (id_form). If there is no Delegate, null.
delegateAuthorities Array.<string>

OfficerAuthority codes for the office of regional WA Delegate.
delegateVotes number

Number of votes the regional WA Delegate has.
wfe string

Body text of the region's World Factbook Entry.
flag string

Absolute URL of the regional flag image file.
isFrontier boolean

true if the region is a frontier, otherwise false.
governor string <nullable>

Nation serving as the regional governor (id_form). If the region has no governor, null.
updateLast number

Timestamp of when the region last updated.
updateMajor number

Timestamp of when the region last updated in the course of a Major update.
updateMinor number

Timestamp of when the region last updated in the course of a Minor update.
name string

Name of the region (Proper Form).
nations Array.<string>

Nations residing in the region (id_form).
nationsNum number

Number of nations residing in the region.
powerLevel string

Textual description of the total influence among nations in the region.
embassies Embassy

Embassies the region has with others.
founder string <nullable>

Nation that founded the region (id_form). If there is no founder, null.
officers Array.<Officer>

Regional officers.

Embassy

Represents a regional embassy.

Type:
  • object
Properties:
Name Type Description
phase string

The embassy's current EmbassyPhase.
region string

Region the embassy is for (Proper Form).

Faction

Represents an N-Day faction.

Type:
  • object
Properties:
Name Type Description
id number

Faction ID.
name string

Faction name.
description string

Faction description.
created number

Timestamp of the faction's founding.
region string

Name of the founding region (Proper Form).
entry number
score number

Faction score - strikes minus radiation.
strikes number

Number of nukes launched by faction members that successfully hit their target.
radiation number

Number of nukes that have hit faction members.
production number

Amount of production stored by faction members.
nukes number

Number of nukes stockpiled by faction members.
shields number

Number of shields stockpiled by faction members.
targets number

Number of nukes faction members are aiming.
launches number

Number of nukes faction members are launching.
targeted number

Number of nukes aimed at faction members.
incoming number

Number of nukes launched at faction members.

ForAgainst

Container for ordering vote data by votes For and Against.

Type:
  • Object

FreedomsScoreData

Container object holding numerical data on a nation's civil, economic, and political freedoms, all rounded to the nearest integer value.

Type:
  • object
Properties:
Name Type Description
civil string

The nation's civil rights score.
economic string

The nation's economical freedom score.
political string

The nation's political freedom score.

FreedomsTextData

Container object holding descriptions on a nation's civil, economic, and political freedoms.

Type:
  • object
Properties:
Name Type Description
civil string

The nation's civil rights situation.
economic string

Extent of economic freedom the nation grants.
political string

Level of the nation's political freedom.

Happening

Represents a happening event in the NationStates world.

Type:
  • object
Properties:
Name Type Description
timestamp number

Timestamp of when the happening occurred.
text string

Description of what transpired in the happening.

HDIData

Container object holding data on the different component scores that ultimately combine into a nation's final World Census HDI score.

Type:
  • object
Properties:
Name Type Description
score number

The final HDI score.
economy number

The economic score component.
education number

The educational score component.
lifespan number

The life expectancy score component.

IDHappening

Represents a happening event in the NationStates world.

Type:
  • object
Properties:
Name Type Description
id number

Happening ID.
timestamp number

Timestamp of when the happening occurred.
text string

Description of what transpired in the happening.

Issue

Represents an issue confronting a nation.

Type:
  • object
Properties:
Name Type Description
id number

Issue ID.
title string

Issue title.
description string

Issue description - the problem to be solved.
options Array.<IssueOption>

Available answer options.
author Array.<string>

Names of the nations that authored the issue.
editor Array.<string>

Names of the nations that edited the issue.
imageLarge string

Banner code of the large image shown on the issue.
imageSmall string

Banner code of the small image shown on the issue.

IssueEffect

Represents the outcome of the chosen answer on an issue.

Type:
  • object
Properties:
Name Type Description
issue number

ID of the issue that was answered.
option number

(Issue-internal) ID of the option that was chosen.
ok boolean

Whether everything went alright, I guess?
legislation string

The effect line of the chosen issue option.
headlines Array.<string>

List of all generated newspaper headlines.
banners Array.<string>

List of the banner codes of banners newly unlocked.
policiesEnacted Array.<Policy>

List of all national policies newly enacted.
policiesCancelled Array.<Policy>

List of all national policies newly rescinded.
census Array.<RankChange>

List of changes to the nation's census scores.
reclassifications Array.<Reclassification>

List of reclassifications of the nation's freedom levels.

IssueOption

Represents an option that may be chosen to answer an issue.

Type:
  • object
Properties:
Name Type Description
id number

Issue-internal ID of the option.
text string

Body text describing the option.

IssueOptionWarning

Represents an extraordinary warning attached to an IssueOption.

Type:
  • object
Properties:
Name Type Description
option number

Issue-internal ID of the option the warning is for.
text string

Body text of the warning.

LegalityData

Container object holding data on a proposal's current legal status - that is, the decisions of Moderators or members of the GA General Secretariat on the proposal's compliance with the SC/GA ruleset.

Type:
  • object
Properties:
Name Type Description
legal Array.<string>

Nations ruling the proposal legal (id_form).
illegal Array.<string>

Nations ruling the proposal illegal (id_form).
discard Array.<string>

Nations voting to discard the proposal (id_form).
log Array.<LegalityDecision>

Log of rulings made on the proposal.

LegalityDecision

Represents a ruling of a Moderator or a member of the General Secretariat concerning the legality of a concrete Proposal.

Type:
  • object
Properties:
Name Type Attributes Description
nation string

Nation that made the ruling (id_form).
ruling string

The LegalityRuling made.
reason string <nullable>

Comment attached to the ruling; null if there is no comment.
timestamp number

Timestamp of when the ruling was made.

ListCard

Represents a card with only the most basic data present, as when displayed as part of a listing of multiple cards.

Type:
  • object
Properties:
Name Type Description
id number

ID of the card (and the depicted nation).
rarity string

Rarity of the card.
season number

ID of the season that the card was inscribed for.

ListCollection

Represents a collection of cards with only the most basic data present, as when displayed as part of a listing of multiple collections.

Type:
  • object
Properties:
Name Type Description
id number

ID of the collection.
name string

Name of the collection.
edited number

Timestamp of the last change to the collection.

ListDispatch

Represents a dispatch, without its body text.

Type:
  • object
Properties:
Name Type Description
id number

ID of the dispatch.
title string

The dispatch's title.
author string

Nation that published the dispatch (id_form).
categoryTop string

DispatchCategory of the dispatch.
categorySub string

DispatchSubcategory of the dispatch.
posted number

Timestamp of the dispatch's original publication.
edited number

Timestamp of the last edit to the dispatch. If there haven't been any edits, 0.
views number

Number of views on the dispatch.
score number

The dispatch's score - upvotes minus downvotes.

ListFaction

Represents an N-Day faction with only the most basic information present, as when displayed as part of a listing of multiple factions.

Type:
  • object
Properties:
Name Type Description
id number

Faction ID.
name string

Faction name.
score number

Faction score.
region string

Name of the founding region (Proper Form).
numMembers number

Number of nations that are members of the faction.

ListIssue

Represents an issue by title and ID.

Type:
  • object
Properties:
Name Type Description
id number

ID of the issue.
title string

Title of the issue, shown as a newspaper headline.

Market

Represents an ask or bid on a card in the auction house.

Type:
  • object
Properties:
Name Type Description
nation string

Nation entertaining this market (id_form).
bank number

Amount of bank this market is worth.
isAsk boolean

true if the market is an Ask, false if it's a Bid.
timestamp number

Timestamp of when this market was created.

Nation

Represents a nation in the NationStates multiverse, containing all the data requested from the Nation API.

Properties:
Name Type Attributes Description
idForm string

Name of this nation in id_form.
admirable string <optional>

A random Admirable the nation is eligible for.
admirables Array.<string> <optional>

All Admirables the nation is eligible for.
animal string <optional>

National animal of the nation.
animalTrait string <optional>

Behaviour of the national animal.
banner string <optional>

Banner code of the banner to display for the nation. If the nation has set a primary banner, this is always the code of that primary banner; otherwise, it is randomly selected from all banners the nation has unlocked and not turned off.
banners Array.<string> <optional>

Banner codes of all banners the nation has unlocked and not turned off. If the nation has set a primary banner, the banner code of it is listed first.
category string <optional>

World Census category of the nation, e.g. New York Times Democracy.
crime string <optional>

Textual description of crime levels in the nation.
currency string <optional>

Name of the nation's currency.
dbID number <optional>

Database ID of the nation.
demonymAdjective string <optional>

The adjective demonym for the nation.
demonymNoun string <optional>

The singluar noun demonym for the nation.
demonymPlural string <optional>

The plural noun demonym for the nation.
dispatchNum number <optional>

Number of extant dispatches the nation wrote.
dossierNations Array.<string> <optional>

Nations in the dossier of the nation (id_form).
endorsements Array.<string> <optional>

Nations endorsing this nation (id_form).
factbookNum number <optional>

Number of extant factbooks the nation authored.
firstLogin number <optional>

Timestamp of the nation's first login.
flag string <optional>

Absolute URL of the national flag image file.
founded string <optional>

Textual description of when the nation was founded, relative to now.
foundedTimestamp number <optional>

Timestamp of the nation's founding.
nameFull string <optional>

Full name of the nation.
voteGA string <optional>

WAVote of the nation in the GA.
gdp number <optional>

GDP of the nation.
government string <optional>

Textual description of what the national government is doing.
spendingPriority string <optional>

Single largest field within the nation's expenditure.
incomeAverage number <optional>

Average income of national citizens.
descriptionIndustry string <optional>

Textual description of the economic situation in the nation.
influence string <optional>

Influence level of the nation in its region.
issuesAnswered number <optional>

Number of issues the nation has answered.
lastLogin string <optional>

Textual description of the time of the nation's last login, relative to now.
lastLoginTimestamp number <optional>

Timestamp of the nation's last login.
legislation Array.<string> <optional>

Effect lines of the nation's four most recently answered issues.
majorIndustry string <optional>

Largest industry in the nation.
motto string <optional>

National motto.
name string <optional>

Name of the nation (Proper Form).
nextIssue string <optional>

Textual description of when the nation will face its next issue, relative to now.
nextIssueTime number <optional>

Timestamp for when the nation will face its next issue.
notable string <optional>

A random Notable the nation is eligible for.
notables Array.<string> <optional>

All Notables the nation is eligible for.
packs number <optional>

Number of unopened card packs the nation has.
ping boolean <optional>

true if the ping to the nation was successful, otherwise false.
incomePoorest number <optional>

Average income of the poorest 10% of national citizens.
population number <optional>

Number of citizens the nation has, in millions.
gdpGovernment number <optional>

Percentage of the nation's GDP that is generated directly by government action.
dossierRegions Array.<string> <optional>

Regions in the dossier of the nation (id_form).
region string <optional>

Region the nation resides in (Proper Form).
incomeRichest number <optional>

Average income of the richest 10% of national citizens.
voteSC string <optional>

WAVote of the nation in the SC.
sensibilities Array.<string> <optional>

All enums.Sensibility traits of the nation's citizens.
tax number <optional>

Average income tax rate in the nation.
receivesCampaign boolean <optional>

true if the nation would accept the defined campaign telegram, otherwise false.
receivesRecruit boolean <optional>

true if the nation would accept the defined recruitment telegram, otherwise false.
pretitle string <optional>

National pretitle.
waStatus string <optional>

WAStatus of the nation.
capital string <optional>

Name of the national capital.
capitalCustom string <optional>

Custom name for the national capital, if set.
leader string <optional>

Name of the national leader.
leaderCustom string <optional>

Custom name for the national capital, if set.
religion string <optional>

Name of the national religion.
religionCustom string <optional>

Custom name for the national religion, if set.
verified boolean <optional>

true if a login of the nation was successfully verified, otherwise false.
census Array.<CensusDataNation> <optional>

Performance of the nation on the queried CensusScales.
deaths DeathData <optional>

Details on the causes of death in the nation.
dispatchList ListDispatch <optional>

Extant dispatches the nation authored.
factbookList ListDispatch <optional>

Extant factbooks the nation authored.
freedomDescriptions FreedomsTextData <optional>

Textual descriptions of the freedom levels in the nation.
freedomScores FreedomsScoreData <optional>

Scores for the freedom levels in the nation.
expenditure SpendingData <optional>

Details of national government expenditure.
happenings Array.<Happening> <optional>

Recent national happening events.
hdi HDIData <optional>

Composition of the nation's HDI score.
issues Array.<Issue> <optional>

Issues currently confronting the nation.
issueSummaries Array.<ListIssue> <optional>

Titles and IDs of issues currently confronting the nation.
notices Array.<Notice> <optional>

Notices of the nation.
policies Array.<Policy> <optional>

National policies.
censusRankRegion CensusRankUnscored <optional>

Rank of the nation on the day's featured CensusScale among region-mates.
sectors SectorsData <optional>

Composition of the nation's GDP, by sector.
unreads UnreadsData <optional>

Stuff not yet acknowledged by the nation.
badges Array.<WABadge> <optional>

Badges awarded to the nation by the SC.
censusRank CensusRankUnscored <optional>

Rank of the nation on the day's featured CensusScale world-wide.
zombie ZombieDataNation <optional>

Details on the national Z-Day performance.

NewNation

Represents the founding details of a newly founded nation.

Type:
  • object
Properties:
Name Type Description
nation string

Name of the nation (id_style).
region string

Name of the nation's founding region (id_style).
founded number

Timestamp of the founding.

Notice

Represents a notice alert generated for a nation.

Type:
  • object
Properties:
Name Type Attributes Description
title string

Notice title.
text string

Notice description.
time number

Timestamp of notice generation.
type string

NoticeType of the notice.
icon string <nullable>

Displayed NoticeIcon; null if no icon is displayed.
url string

URL to open when the notice is clicked.
who string

Nation who caused the notice to be generated (id_form).
isNew boolean

true if viewed before, otherwise false.
ok boolean

No idea.

Officer

Represents a regional officer of a region.

Type:
  • object
Properties:
Name Type Description
nation string

Nation holding the office (id_form).
office string

Name of the office.
appointer string

Nation that appointed the officer (id_form).
authorities Array.<string>

OfficerAuthority codes for the officer.
appointment number

Timestamp of the officer's appointment.
order number

Position on which the officer is displayed (1-indexed).

Policy

Represents a national policy.

Type:
  • object
Properties:
Name Type Description
category string

General field the policy concerns.
name string

Name of the policy.
description string

Short description of the policy content.
image string

ID of the policy banner image.

Poll

Represents a regional poll.

Type:
  • object
Properties:
Name Type Attributes Description
id number

Poll ID.
title string

Poll title.
description string <optional>

Poll description.
author string

Nation that created the poll (id_form).
region string

Region that the poll is running in (id_form).
opens number

Timestamp for when the poll opens.
closes number

Timestamp for when the poll closes.
options Array.<PollOption>

The available answer options.

PollOption

Represents a voting option on a regional poll.

Type:
  • object
Properties:
Name Type Description
id number

Poll-internal ID of this option.
text string

Text of this option.
votes number

Number of votes for this option.
voters Array.<string>

Nations voting for this option (id_form).

Proposal

Represents a proposal for a new resolution currently before the delegates of the World Assembly.

Type:
  • object
Properties:
Name Type Description
id string

Proposal ID.
title string

Proposal title.
author string

Nation that submitted the proposal (id_form).
coauthors Array.<string>

List of co-authoring nations (id_form).
text string

Body text of the proposal.
approvals Array.<string>

WA delegates approving the proposal (id_form).
submitted number

Timestamp of proposal submission.
category string

Category of the resolution.
option string

For GA resolutions and SC declarations, the subcategory of the resolution; otherwise its target nation or region (id_form).
legality LegalityData

Rulings on the proposal's legality.

RankChange

Represents a change in a nation's performance on a World Census scale.

Type:
  • object
Properties:
Name Type Description
scale number

Affected CensusScale.
changeAbsolute number

Score change on the scale in its units.
changeRelative number

Score change on the scale in percent.
newScore number

New (absolute) score on the scale.

Reclassification

Represents a reclassification of a nation's level of civil, economic, or political freedom through an AnsweredIssue.

Type:
  • object
Properties:
Name Type Description
category number

The ReclassificationCategory.
from string

Level of the freedom prior to answering the issue.
to string

Level of the freedom after answering the issue.

Region

Represents a region in the NationStates multiverse, containing all the data requested from the Region API.

Type:
  • object
Properties:
Name Type Attributes Description
idForm string

Name of this region in id_form.
banlist Array.<string> <optional>

Nations on the region's banlist (id_form).
bannerID string <optional>
<nullable>

ID of the regional banner. If the region doesn't fly a custom banner, null.
bannerCreator string <optional>

Nation that set the regional banner (id_form).
bannerURL string <optional>

Relative URL of the regional banner image file.
dbID number <optional>

Database ID of the region.
pinnedDispatches Array.<number> <optional>

IDs of dispatches currently pinned to the region's WFE.
delegateName string <optional>
<nullable>

Nation serving as the regional WA Delegate (id_form). If there is no Delegate, null.
delegateAuthorities Array.<string> <optional>

The WA Delegate's OfficerAuthority codes.
delegateVotes number <optional>

Number of votes the regional WA Delegate has.
crossposting string <optional>

The region's embassy CrosspostingPolicy.
wfe string <optional>

Body text of the region's World Factbook Entry.
flag string <optional>
<nullable>

Absolute URL of the regional flag image file. If the region doesn't fly a flag, null.
founded string <optional>

Textual description of when the region was founded, relative to now.
foundedTimestamp number <optional>

Timestamp of the region's founding. A founding in antiquity is represented with 0.
isFrontier boolean <optional>

true if the region is a frontier, otherwise false.
governor string <optional>
<nullable>

Nation serving as the regional governor (id_form). If the region has no governor, null.
updateLast number <optional>

Timestamp of when the region last updated.
updateMajor number <optional>

Timestamp of when the region last updated in the course of a Major update.
updateMinor number <optional>

Timestamp of when the region last updated in the course of a Minor update.
name string <optional>

Name of the region (Proper Form).
nations Array.<string> <optional>

Nations residing in the region (id_form).
nationsNum number <optional>

Number of nations residing in the region.
nationsWA Array.<string> <optional>

Number of WA members residing in the region.
nationsWANum number <optional>

WA members residing in the region (id_form).
powerLevel string <optional>

Textual description of the total influence among nations in the region.
tags Array.<string> <optional>

Tags the region has.
census Array.<CensusDataRegion> <optional>

Performance of the region on the queried CensusScales.
censusRanks Array.<CensusRankScored> <optional>

Resident nations ranked by their score on the queried CensusScale.
embassies Embassy <optional>

Embassies the region has with others.
founder string <optional>
<nullable>

Nation that founded the region (id_form). If there is no founder, null.
voteGA VoteTally <optional>

Tally of votes For and Against the at-vote GA resolution by resident WA members.
happenings Array.<Happening> <optional>

Recent regional happening events.
history Array.<Happening> <optional>

Significant happening events from the regional history.
messages Array.<RMBPost> <optional>

RMB posts that matched the RMB post query.
rmbMostPosts Array.<RMBActivity> <optional>

Nations' aggregate posting activity on the region's RMB, as queried.
rmbMostLikesGiven Array.<RMBActivity> <optional>

Nations' aggregate likes given on the region's RMB, as queried.
rmbMostLikesReceived Array.<RMBActivity> <optional>

Nations' aggregate likes received on the region's RMB, as queried.
officers Array.<Officer> <optional>

Regional officers.
poll Poll <optional>
<nullable>

Poll currently running in the region; null if there is no active poll.
voteSC VoteTally <optional>

Tally of votes For and Against the at-vote SC resolution by resident WA members.
badges Array.<WABadge> <optional>

Badges awarded to the region by the SC.
zombie ZombieDataRegion <optional>

Details of the regional Z-Day performance.

Resolution

Represents an at-vote or passed resolution in the World Assembly.

Type:
  • object
Properties:
Name Type Attributes Description
id string

Council-internal resolution ID. If the resolution has not been passed yet, this is its proposal ID.
idOverall number <optional>

Overall ID of the resolution. Both councils' resolutions are pooled together for the overall ID. Only available on passed resolutions.
title string

Resolution title.
author string

Nation that submitted the resolution (id_form).
coauthors Array.<string>

List of co-authoring nations (id_form).
text string

Body text of the resolution.
submitted number

Timestamp of the resolution's submission.
promoted number <optional>

Timestamp of when voting started on the resolution. Only available on at-vote resolutions.
implemented number <optional>

Timestamp of the resolution's passage, if applicable.
repealed number <optional>

ID of the resolution this resolution was repealed by. Only available on passed, repealed resolutions.
category string

Category of the resolution.
option string

For GA resolutions and SC declarations, the subcategory of the resolution; otherwise its target nation or region (id_form).
vote VoteSummary

Data on the current votes on the resolution.

RMBActivity

Container object holding data on a nation's aggregate RMB activity.

Type:
  • object
Properties:
Name Type Description
nation string

Nation the data is for (id_form).
score number

Aggregate score of the nation.

RMBPost

Represents a message post lodged to a region's Regional Message Board.

Type:
  • object
Properties:
Name Type Attributes Description
id number

Post ID.
nation string

Nation that made the post (id_form).
text string

Body text of the post.
likes number

Number of likes on the post.
likers Array.<string>

Nations that liked the post (id_form).
timestamp number

Timestamp of when the post was made.
status number

RMBPostStatus of the post.
suppressor string <optional>

Nation that suppressed the post, if applicable.

SectorsData

Container object for data on the composition of a nation's GDP, by percent generated by sector.

Type:
  • object
Properties:
Name Type Description
blackMarket number

Percent generated by black market activity.
government number

Percent generated by direct government activity.
private number

Percent generated by privately-owned industry.
stateOwned number

Percent generated by state-owned industry.

SpendingData

Container object for data on a nation's government spending by field, in percentages.

Type:
  • object
Properties:
Name Type Description
admin number

Percentage spent on the bureaucracy.
defence number

Percentage spent on defence.
education number

Percentage spent on education.
nature number

Percentage spent on environmental stuff.
healthcare number

Percentage spent on the healthcare system.
industry number

Percentage spent on corporate welfare.
aid number

Percentage spent on providing international aid.
order number

Percentage spent on law enforcement.
transport number

Percentage spent on the public transport system.
social number

Percentage spent on social policy.
religion number

Percentage spent on spiritual policy.
welfare number

Percentage spent on the welfare system.

TGQueue

Container object specifying the total number of telegrams that are currently awaiting delivery, divided by the type of queue.

Type:
  • object
Properties:
Name Type Description
manual number

Number of manually-sent telegrams.
mass number

Number of mass telegrams.
api number

Number of telegrams sent via the API.

Trade

Represents the transfer of a card from one nation to another (whether by gift or auction) from the view of the open market.

Type:
  • object
Properties:
Name Type Description
card ListCard

The card transferred.
buyer string

Nation that received the card (id_form).
seller string

Nation that gave the card (id_form).
price number

Amount of bank the receiver paid; 0.0 for gifts.
timestamp number

Timestamp of when the transfer occurred.

TradeCardbound

Represents the transfer of a card from one nation to another (whether by gift or auction) from the view of a specific card's details page.

Type:
  • object
Properties:
Name Type Description
buyer string

Nation that received the card (id_form).
seller string

Nation that gave the card (id_form).
price number

Amount of bank the receiver paid; 0.0 for gifts.
timestamp number

Timestamp of when the transfer occurred.

Trophy

Represents a commendation, condemnation, liberation, or injunction badge displayed on a nation or region.

Type:
  • object
Properties:
Name Type Description
census number

CensusScale the trophy is for.
percent 10 | 5 | 1

Percentile the trophy is for.
rank number

World-wide rank for the census.

UnreadsData

Container object for data on a nation's number of unread issues, telegrams, notices, and RMB and News posts, as well as the number of at-vote WA resolutions it has not yet cast its vote on.

Type:
  • object
Properties:
Name Type Description
issue number

Number of pending issues.
telegram number

Number of unread telegrams.
notice number

Number of unread notices.
rmb number

Number of unread posts on the RMB of the nation's region.
wa number

Number of WA resolutions the nation has not yet voted on.
news number

Number of unread news page posts.

VoteSummary

Container object holding data on the state of voting a resolution.

Type:
  • object
Properties:
Name Type Attributes Description
total ForAgainst.<number>

Vote totals.
track ForAgainst.<Array.<number>> <optional>

Progression of vote totals, array entries representing the respective vote total in hourly intervals.
nations ForAgainst.<Array.<string>> <optional>

Names of individual voters.
nationsNum ForAgainst.<number> <optional>

Numbers of individual voters.
delegates ForAgainst.<DelegateActiveVote> <optional>

The details of regional delegates' standing votes.
delegatesLog Array.<DelegateLogVote> <optional>

Historical log of regional delegates casting their votes.

VoteTally

Represents a regional tally of votes For and Against a resolution in the World Assembly.

Type:
  • object
Properties:
Name Type Description
for number

Number of votes in favor of the resolution; NaN if there is no resolution at vote or no nations have voted For yet.
against number

Number of votes against the resolution; NaN if there is no resolution at vote or no nations have voted Against yet.

WABadge

Represents a commendation, condemnation, liberation, or injunction badge displayed on a nation or region.

Type:
  • object
Properties:
Name Type Description
resolution number

ID of the SC resolution imposing the badge.
type string

WABadgeType of the badge.

WCensusAverage

Container object for national score averages on a given World Census scale.

Type:
  • object
Properties:
Name Type Description
id number

CensusScale the average is for.
average number

World-wide average score of nations on the scale.

World

Represents the world of the NationStates multiverse, containing all the data requested from the World API.

Type:
  • object
Properties:
Name Type Attributes Description
censusID number <optional>

The day's featured CensusScale.
featured string <optional>

The day's featured region (id_form).
lastEventID number <optional>

ID of the most recent happening event visible to the API.
nations Array.<string> <optional>

Names of currently existing nations (id_form).
nationsNew Array.<string> <optional>

Names of the 50 most recently founded nations (id_form).
nationsNum number <optional>

Number of currently existing nations.
regionsNum number <optional>

Number of currently existing regions.
regions Array.<string> <optional>

Names of currently existing regions (id_form).
regionsByTag Array.<string> <optional>

Names of all regions matching the queried Tag requirements.
banners Array.<Banner> <optional>

Details of the queried banners.
censusAverages Array.<WCensusAverage> <optional>

Average national scores on the queried CensusScale.
censusScale string <optional>

Name of the units the queried CensusScale is measured in.
censusTitle string <optional>

Title of the queried CensusScale.
censusDescription CensusDescription <optional>

Info texts displayed for the queried CensusScale.
censusRanks Array.<CensusRankScored> <optional>

Ranking of nations on the queried CensusScale.
dispatch Dispatch <optional>

Details of the queried dispatch.
dispatchList Array.<ListDispatch> <optional>

Dispatches that matched the selected dispatch filters.
faction Faction <optional>

Details of the queried N-Day faction.
factionList Array.<ListFaction> <optional>

Extant N-Day factions.
happenings Array.<IDHappening> <optional>

Happening events that matched the selected happenings filters.
nationsNewDetails Array.<NewNation> <optional>

Founding details of the 50 most recently founded nations.
poll Poll <optional>

Details of the queried poll.
tgQueue TGQueue <optional>

Details of the telegram queue.

WorldAssembly

Represents a council of the World Assembly in the NationStates multiverse, containing all the data requested from the World Assembly API.

Type:
  • object
Properties:
Name Type Attributes Description
council number

The covered WACouncil.
lastResolution string <optional>

Description of the result of the last vote.
delegates Array.<string> <optional>

Currently serving WA delegates (id_form).
delegatesNum number <optional>

Number of currently serving WA delegates.
members Array.<string> <optional>

Current WA member nations (id_form).
membersNum number <optional>

Number of current WA member nations.
happenings Array.<Happening> <optional>

Recent WA happening events.
proposals Array.<Proposal> <optional>

Current proposals.
resolution Resolution <optional>

Details of the at-vote (or the queried) resolution.

ZombieDataNation

Container object for data on a nation's Z-Day performance.

Type:
  • object
Properties:
Name Type Description
intended string

ZombieAction the nation originally selected.
action string

ZombieAction the nation is actually executing, possibly involuntarily.
survivors number

Millions of citizens alive and well.
zombies number

Millions of zombified citizens.
dead number

Millions of deceased citizens.

ZombieDataRegion

Container object for data on the Z-Day performance of a region's residents.

Type:
  • object
Properties:
Name Type Description
survivors number

Millions of national citizens alive and well.
zombies number

Millions of zombified national citizens.
dead number

Millions of deceased national citizens.