API Reference

Complete API reference documentation for interacting with Bitplanet blockchain.

Overview

Bitplanet provides multiple API interfaces for different use cases:

API Type	Port	Use Case	Best For
REST API	1317	HTTP queries for blockchain state	Backend services, simple integrations
gRPC	9090	High-performance typed RPC	Advanced clients, high-throughput apps
CLI	-	Command-line interface	Development, testing, node operations

Choosing the Right API

• Use REST API when:

  • Building backend services with HTTP clients

  • Simple blockchain queries

  • Need human-readable HTTP endpoints

  • Prototyping and testing

• Use gRPC when:

  • Need high performance and low latency

  • Building production-grade services

  • Want strong typing with Protocol Buffers

  • Need streaming capabilities

• Use CLI when:

  • Local development and testing

  • Node operations and administration

  • Scripting and automation

  • Learning and exploration

Network Endpoints

Local Development

• Local endpoints are available when you run the local testnet.

Public Testnet

• Check official documentation for current testnet endpoints.

Mainnet

• Check official documentation for current mainnet endpoints.

Authentication & Security

Local Development

• No authentication required for local endpoints

• Private keys stored in keyring

Production

• Use HTTPS/TLS for all connections

• Implement API key authentication if exposing endpoints

• Never expose private keys in code or logs

• Use environment variables for sensitive configuration

Next Steps

• REST API Reference - Complete REST endpoint reference

• gRPC API Reference - Complete gRPC service reference

• CLI Reference - Complete CLI command reference

• Quick Start - Learn how to use these APIs

---

Related:

• Developer Guides

• Module API

• Smart Contract Integration

• Node Operation