Skip to main content

API Reference

The Shamwari Network API provides comprehensive access to blockchain data and operations. All endpoints return JSON and are accessible via HTTP GET or POST.

Quick Navigation​

Use the sidebar to browse endpoints by category, or use the search bar to find specific endpoints.

Base URL​

http://localhost:6876/nxt

HTTPS (if enabled):

https://localhost:6877/nxt

Authentication​

Most endpoints are public. The following require authentication:

  • Secret Phrase: secretPhrase parameter for transaction signing
  • Admin Password: adminPassword for administrative operations

Response Format​

{
  "requestType": "endpointName",
  "...response fields...": "...",
  "errorCode": 0,
  "errorDescription": ""
}

Error Codes​

CodeDescription
1Incorrect request
2Unknown request type
3Unknown account
4Unknown block
5Insufficient balance
6Not enough funds
7Invalid parameter
8Already have
9Deadline already passed
10Phasing only

Common Parameters​

ParameterDescription
requestTypeAPI endpoint name
chainChain ID
requireBlockBlock ID for response
requireLastBlockLast block ID for response
secretPhraseAccount passphrase
publicKeyAccount public key
accountAccount ID or NXT-format address
adminPasswordAdmin password
firstIndexPagination start
lastIndexPagination end
includeLessorsInclude lessor information
includeCurrenciesInclude currency holdings
includeEffectiveBalanceInclude effective balance

API Categories​