Quick Start
This guide will get you interacting with the Shamwari API in minutes.
Start the Node
Ensure your Shamwari node is running using the unified startup script:
./run-shamwari.sh
For background execution, run:
./run-shamwari.sh --daemon
Your First API Call
Get Blockchain Status
curl "http://localhost:22024/nxt?requestType=getBlockchainStatus"
Generate or Retrieve Account Details
curl "http://localhost:22024/nxt?requestType=getAccountId&secretPhrase=your_passphrase"
Response:
{
"account": "1234567890123456789",
"accountRS": "SHAMWARI-XXXX-XXXX-XXXX-XXXXX",
"publicKey": "abc123..."
}
Check Balance
curl "http://localhost:22024/nxt?requestType=getBalance&account=SHAMWARI-XXXX-XXXX-XXXX-XXXXX"
Using the Built-In API Console
Access the built-in API test harness in your browser:
http://localhost:22024/test.html
Using the Java Client Library
Add the dependency to your project:
<dependency>
<groupId>network.shamwari</groupId>
<artifactId>shamwariQKP</artifactId>
<version>2.2.6</version>
</dependency>
Next Steps
- Read the Installation Guide for detailed setup
- Explore the API Reference for all available endpoints
- Learn about Architecture to understand the internals