Legal shards to query with requests to the NationStates API.
Members
(static, constant) CardDetailShard :string
Valid shards to query in requests to the (individual) cards endpoint of the API.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
INFO |
string | Get the data of the nation depicted on the card. |
MARKETS |
string | Get the active asks and bids (markets) on the card. |
OWNERS |
string | Get the names of the nations currently owning a copy of the card. |
TRADES |
string | Get transfers of the card, whether by gift or auction. |
(static, constant) CardShard :string
Valid shards to query in requests to the (deck/world) cards endpoint of the API.
Note: Querying multiple at once can cause the request to load longer than usual.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
ASKS_BIDS |
string | Get current asks and bids (markets) of a defined nation. |
AUCTIONS |
string | Get currently ongoing auctions. |
CARDS |
string | Get the trading cards in the deck of a defined nation. |
COLLECTION_DETAILS |
string | Get the trading cards in a defined collection. |
COLLECTIONS |
string | Get the collections of a defined nation. |
DECK_SUMMARY |
string | Get aggregate info on the deck of a defined nation. |
TRADES |
string | Get transfers of cards, whether by gift or auction. |
(static, constant) NationPrivateShard :string
Valid shards to query in requests to the nations endpoint of the API. If private shards are requested, the request must authenticate as the respective nation.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
DOSSIER_NATIONS |
string | Get a list with the names of all nations currently saved in the nation's dossier. |
DOSSIER_REGIONS |
string | Get a list with the names of all regions currently saved in the nation's dossier. |
ISSUES |
string | Get a list with the details of all issues currently confronting the nation. |
ISSUES_SUMMARY |
string | Get a list with the names and IDs of all issues currently confronting the nation. |
NEXT_ISSUE |
string | Get a textual description of when the nation will receive its next issue (e.g. 'in 1 hour'). |
NEXT_ISSUE_TIME |
string | Get the Unix epoch timestamp for when the nation will receive its next issue. |
NOTICES |
string | Get a list of the nation's notices from the last 48 hours, but always all unread ones. An alternate time to display notices from can be set. |
PACKS |
string | Get the number of unopened trading card packs the nation currently possesses. |
PING |
string | Simply login to the nation without querying anything else. |
UNREADS |
string | Get the current number of new WA resolutions at vote, unaddressed issues, and unread telegrams, notices, and RMB and news posts. |
(static, constant) NationShard :string
Valid shards to query in requests to the nations endpoint of the API.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
ADMIRABLE |
string | Get a random admirable the nation is eligible for, e.g. 'environmentally stunning'. |
ADMIRABLES |
string | Get the full list of admirables the nation is eligible for. |
ANIMAL |
string | Get the nation's national animal. |
ANIMAL_TRAIT |
string | Get the behaviour of the nation's national animal, e.g. 'frolics freely in the nation's many lush forests'. |
BANNER |
string | Get the code of the nation's primary banner, if one is set, otherwise that of a random one the nation has. |
BANNERS |
string | Get a list with all banner codes for the banners the nation has unlocked. |
CAPITAL |
string | Get the name of the nation's capital. |
CATEGORY |
string | Get the nation's national classification, e.g. 'New York Times Democracy'. |
CENSUS |
string | Get the nation's performance - e.g. score, rank, historical development - on a World Census scale. |
CENSUS_RANK |
string | Get the nation's world-wide rank on today's featured World Census scale. |
CENSUS_RANK_REGION |
string | Get the nation's region-wide rank on today's featured World Census scale. |
CRIME |
string | Get a full textual description for the nation's level of crime. |
CURRENCY |
string | Get the name of the nation's currency. |
CUSTOM_CAPITAL |
string | Get the custom name of the nation's capital; if one is set, this is equal to the |
CUSTOM_LEADER |
string | Get the custom name of the nation's leader; if one is set, this is equal to the |
CUSTOM_RELIGION |
string | Get the custom name of the nation's religion; if one is set, this is equal to the |
DATABASE_ID |
string | Get the ID of the nation in the NationStates database. The ID corresponds to the nation's card ID. |
DEATHS |
string | Get a breakdown of the different causes of death in the nation. |
DEMONYM_ADJECTIVE |
string | Get the nation's adjective demonym. |
DEMONYM_NOUN |
string | Get the nation's noun demonym. |
DEMONYM_NOUN_PLURAL |
string | Get the nation's noun demonym in plural form. |
DISPATCHES |
string | Get the number of dispatches the nation has published. This includes factbooks. |
DISPATCH_LIST |
string | Get a list with basic information on the nation's published dispatches. This includes factbooks. |
ENDORSEMENTS |
string | Get a list with the names of all nations currently endorsing the nation. |
FACTBOOKS |
string | Get the number of factbooks the nation has published. |
FACTBOOK_LIST |
string | get a list with basic information on the nation's published factbooks. |
FIRST_LOGIN |
string | Get the Unix epoch timestamp of when the nation first logged in. |
FLAG |
string | Get the (absolute) URL of the nation's flag. |
FOUNDED |
string | Get a textual description of the nation's founding date relative to today, e.g. '1 year 234 days ago'. |
FOUNDED_TIME |
string | Get the Unix epoch timestamp for when the nation was founded. |
FREEDOM_DESCRIPTIONS |
string | Get text descriptions of the nation's civil rights, economy, and political freedom scores, e.g. 'Good'. |
FREEDOM_SCORES |
string | Get the numerical values of the nation's civil rights, economy, and political freedom scores. |
FULL_NAME |
string | Get the nation's full name - 'The [pretitle] of [name]'. |
GDP |
string | Get the nations GDP score. |
GOVERNMENT_DESCRIPTION |
string | Get a full textual description of the nation's government. |
GOVERNMENT_PRIORITY |
string | Get the name of the expenditure sector on which the nation is spending the most. |
GOVERNMENT_EXPENDITURE |
string | Get a full breakdown of the nation's governmental expenditure by sector. |
HAPPENINGS |
string | Get the ten most recent happening events for the nation. |
HDI |
string | [Undocumented] Get the base values for the calculation of the nation's HDI score. |
INCOME |
string | Get the average income of the nation's citizens. |
INCOME_POOREST |
string | Get the average income of the nation's poorest 10% of citizens. |
INCOME_RICHEST |
string | Get the average income of the nation's richest 10% of citizens. |
INDUSTRY_DESCRIPTION |
string | Get a full textual description of the nation's economy. |
INFLUENCE |
string | Get the nation's influence rank, e.g. 'Apprentice'. |
ISSUES_ANSWERED |
string | Get the total number of issues answered by the nation. |
LAST_LOGIN |
string | Get a textual description of the nation's last login relative to now, e.g. '1 hour ago'. |
LAST_LOGIN_TIME |
string | Get the Unix epoch timestamp of when the nation last logged in. |
LEADER |
string | Get the name of the nation's leader. |
LEGISLATION |
string | Get the effect lines of the last four issues answered by the nation. |
MAJOR_INDUSTRY |
string | Get the name of the nation's largest industrial sector. |
MOTTO |
string | Get the nation's national motto. |
NAME |
string | Get the nation's (authentically capitalized) name. |
NOTABLE |
string | Get a textual representation of three random things the nation is notable for. |
NOTABLES |
string | Get a list with all things the nation is notable for, e.g. 'museums and concert halls'. |
POLICIES |
string | Get a list with the full details of all policies currently in effect within the nation. |
POPULATION |
string | Get the nation's population, in million citizens. |
PRETITLE |
string | Get the nation's pretitle, e.g. 'Kingdom'. |
PUBLIC_SECTOR |
string | Get the percentage of the nation's GDP that is generated by government activity. |
REGION |
string | Get the name of the region the nation currently resides in. |
RELIGION |
string | Get the name of the nation's national religion. |
SECTORS |
string | Get a full breakdown of the nation's GDP by sector in percent. |
SENSIBILITIES |
string | Get a list of all current citizen traits of the nation, e.g. 'devout'. |
TAX |
string | Get the current average income tax rate of the nation. |
TG_RECRUITABLE |
string | Check whether the nation would currently receive a recruitment telegram. A theoretical sender region may be provided additionally. |
TG_CAMPAIGNABLE |
string | Check whether the nation would currently receive a WA campaign telegram. |
WA_STATUS |
string | Get the nation's current status as WA Delegate, member state, or non-member. |
WA_BADGES |
string | Gets the types and corresponding SC resolution IDs of all commendations and condemnations active on the nation. |
VOTE_GA |
string | Get the nation's current stance on the at-vote GA resolution. |
VOTE_SC |
string | Get the nation's current stance on the at-vote SC resolution. |
ZOMBIE |
string | Get the nation's current number of zombies, survivors, and dead citizens, as well as its intended and actual response behaviour. |
(static, constant) RegionShard :string
Valid shards to query in requests to the regions endpoint of the API.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
BANLIST |
string | Get a list with the names of all nations currently banned from the region. |
BANNER |
string | Get the ID of the region's current banner. |
BANNER_UPLOADER |
string | Get the name of the nation that set the region's current banner. |
BANNER_URL |
string | Get the (relative) path to the raw regional banner image. |
CENSUS |
string | Get the average score of all regional nations on a World Census scale. |
CENSUS_RANKS |
string | Get the ranked leaderboard of all regional nations on a World Census scale, 20 nations at a time. |
DATABASE_ID |
string | Get the ID of the region in the NationStates database. |
DELEGATE |
string | Get the name of the region's current WA Delegate. |
DELEGATE_AUTHORITY |
string | Get the officer powers granted to the region's WA Delegate. |
DELEGATE_VOTE_WEIGHT |
string | Get the number of votes the region's WA Delegate currently has in the WA. |
DISPATCHES |
string | Get a list with the IDs of the region's pinned dispatches. |
EMBASSIES |
string | Get a list with the names of all extant embassies of the region, as well as those currently being constructed or withdrawn and invites. |
FLAG |
string | Get the (absolute) path to the region's flag. |
FOUNDED |
string | Get a description of the region's founding date relative to today (e.g. '1 year 234 days ago'). |
FOUNDED_TIME |
string | Get the Unix epoch timestamp for when the region was founded. |
FOUNDER |
string | Get the name of the nation that originally founded the region. |
FRONTIER_STATUS |
string | Get the status of the region as either a Frontier or a Stronghold. |
GOVERNOR |
string | Get the name of the nation that is the region's current Governor. |
HAPPENINGS |
string | Get a list of the most recent nation founding, moving, and CTE, as well as regional admin happening events. |
HISTORY |
string | Get a list of important historical happening events of the region. |
LAST_UPDATE |
string | Get the Unix epoch timestamp for when the region last updated. |
LAST_UPDATE_MAJOR |
string | Get the Unix epoch timestamp for the last major update of the region. |
LAST_UPDATE_MINOR |
string | Get the Unix epoch timestamp for the last minor update of the region. |
NAME |
string | Get the (correctly capitalised) name of the region. |
NATIONS |
string | Get a list with the names of all nations currently residing in the region. |
NUM_NATIONS |
string | Get the total number of nations currently residing in the region. |
NUM_WA_MEMBERS |
string | Get the total number of WA member nations currently residing in the region. |
OFFICERS |
string | Get a list with the appointment and authority details of all current officers of the region. |
POLL |
string | Get the details of the region's current poll, if there is one. |
POWER |
string | Get the overall regional influence level. |
RMB_CROSSPOSTING_POLICY |
string | Get the region's policy regarding the ability to post to its RMB through a regional embassy. |
RMB_MESSAGES |
string | Get a list of the 10 most recent RMB messages in the region. Additional parameters can be set to search for more and older messages. |
RMB_MOST_POSTS |
string | [Undocumented] Get the names of nations that have made the most posts to the region's RMB. Note: This shard may cause a significantly longer waiting time until the API responds. |
RMB_MOST_LIKES |
string | [Undocumented] Get the names of nations that have given out the most likes on the region's RMB. Note: This shard may cause a significantly longer waiting time until the API responds. |
RMB_MOST_LIKED |
string | [Undocumented] Get the names of nations that have received the most likes on the region's RMB. Note: This shard may cause a significantly longer waiting time until the API responds. |
TAGS |
string | Get a list of all tags currently set for this region. |
VOTE_GA |
string | Get the number of votes for and against the current GA proposal from nations residing in the region. |
VOTE_SC |
string | Get the number of votes for and against the current SC proposal from nations residing in the region. |
WA_BADGES |
string | Gets the types and corresponding SC resolution IDs of all commendations, condemnations, liberations, and injunctions active on the region. |
WA_MEMBERS |
string | Get a list with the names of all WA member nations residing in the region. |
WFE |
string | Get the current text of the region's World Factbook Entry. |
ZOMBIE |
string | Get the total current number of zombies, survivors, and dead citizens from among nations residing in the region. |
(static, constant) WAShard :string
Valid shards to query in requests to the WA endpoint of the API.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
DELEGATES |
string | Get a list with the names of all current WA Delegate nations. |
DELEGATE_VOTES |
string | Get a list of all effective Delegate votes, including their respective voting power and time of having voted. |
DELEGATE_VOTE_LOG |
string | Get a complete log of each time a Delegate cast, withdrew, or changed their vote. |
HAPPENINGS |
string | Get a list of the most recent happening events relating to Delegacy changes, proposal submissions/withdrawals/fails, and voting results. |
LAST_RESOLUTION |
string | Get info about the result of the most recently concluded vote. |
MEMBERS |
string | Get a list with the names of all current WA member nations. |
NUM_DELEGATES |
string | Get the total number of current WA Delegates. |
NUM_MEMBERS |
string | Get the total number of current WA member nations. |
PROPOSALS |
string | Get a list of all currently submitted proposals. |
RESOLUTION |
string | Get information about the resolution that is currently at vote. Alternatively, get information about a historical WA resolution. |
VOTERS |
string | Get the names and votes of all nations that have cast a vote on the resolution currently at vote. |
VOTE_TRACK |
string | Get a list of the vote totals on the resolution currently at vote for each hour since voting started. |
(static, constant) WorldShard :string
Valid shards to query in requests to the world endpoint of the API.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
BANNER |
string | Get the names and unlocking requirements for a defined list of national banners. |
CENSUS |
string | Get the average score of all nations on a World Census scale. |
CENSUS_ID |
string | Get the ID of today's featured World Census scale. |
CENSUS_DESCRIPTION |
string | Get the description of a World Census scale. |
CENSUS_NAME |
string | Get the name for the ranked leaderboard of a World Census scale, e.g. 'Most Politically Free'. |
CENSUS_RANKS |
string | Get the ranked leaderboard of all nations on a World Census scale, 20 nations at a time. |
CENSUS_SCALE |
string | Get the name of the scale of a World Census scale, e.g. 'milliStalins'. |
CENSUS_TITLE |
string | Get the name of a World Census Scale, e.g. 'Civil Rights'. |
DISPATCH |
string | Get the raw BBCode of a dispatch. |
DISPATCH_LIST |
string | Get a list with the basic data of the 20 currently trending dispatches. Additional parameters can refine the search criteria. |
FACTION |
string | |
FACTION_LIST |
string | |
FEATURED_REGION |
string | Get the name of today's featured region. |
HAPPENINGS |
string | Get a list of the most recent happening events in the world. Additional parameters can set filter criteria. |
LAST_EVENT_ID |
string | Get the ID of the most recent happening event. |
NATIONS |
string | Get a list with the names of all currently existing nations. |
NEW_NATIONS |
string | Get a list with the fifty most recently founded nations' names. |
NEW_NATIONS_DETAILS |
string | [Undocumented] Get a list of the fifty most recently founded nations, including their names, region of origin, and time of founding. |
NUM_NATIONS |
string | Get the total number of nations that currently exist. |
NUM_REGIONS |
string | Get the total number of regions that currently exist. |
POLL |
string | Get details about a regional poll. |
REGIONS |
string | Get a list with the names of all currently existing regions. |
REGIONS_BY_TAG |
string | Get a list with the names of all regions that have and/or don't have specified tags. |
TG_QUEUE |
string | Get the number of telegrams currently waiting to be delivered in the manual, API, and stamp queues. |