From 1555c24adca55ffb3d3dc1bb0e05b5a0da3a525e Mon Sep 17 00:00:00 2001 From: dultimateade Date: Mon, 27 Jul 2026 23:42:17 +0000 Subject: [PATCH 1/2] Update README.md to enhance project description and add badge links --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0a7fd69..3249182 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,18 @@ # StellarKit API πŸš€ +A lightweight REST API for Stellar that turns Horizon blockchain data into easy-to-use developer endpoints. It helps applications fetch account balances, transaction history, fee estimates, and network status without needing deep Stellar protocol knowledge. +

- English πŸ‡ΊπŸ‡Έ | FranΓ§ais πŸ‡«πŸ‡· | EspaΓ±ol πŸ‡ͺπŸ‡Έ + License: MIT + Node.js + Stellar Network + PRs Welcome

-> StellarKit API is a developer utility service that exposes the Stellar Horizon blockchain through a simple REST interface. It is designed for application developers who need fast, typed access to account details, fee estimates, transaction history, network health, and asset metadata. +

+ English πŸ‡ΊπŸ‡Έ | FranΓ§ais πŸ‡«πŸ‡· | EspaΓ±ol πŸ‡ͺπŸ‡Έ +

-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![Node.js](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org/) -[![Stellar](https://img.shields.io/badge/Stellar-SDK-blue)](https://stellar.org) -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md) --- From e2aebd3d5c458f87bfaf3ed551cffe6eb4f23e36 Mon Sep 17 00:00:00 2001 From: dultimateade Date: Tue, 28 Jul 2026 23:52:45 +0000 Subject: [PATCH 2/2] docs: refine README overview and remove inconsistencies --- README.md | 47 ++++++++++++++++++++++++----------------------- 1 file changed, 24 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 3249182..2b6b833 100644 --- a/README.md +++ b/README.md @@ -18,38 +18,39 @@ A lightweight REST API for Stellar that turns Horizon blockchain data into easy- ## What is StellarKit API? -StellarKit API is a wrapper around the Stellar Horizon API, built with Express.js and the official `@stellar/stellar-sdk` library. It normalizes Horizon responses, provides a clean REST structure, and adds convenience endpoints for the most common Stellar developer workflows. +StellarKit API is a lightweight, production-ready Express service for exploring Stellar network data through a clean REST interface. It combines Horizon data with Soroban RPC support, normalizes common responses, and exposes practical endpoints for account analysis, fee estimation, asset intelligence, DEX and liquidity-pool data, claimable balances, and live streaming. -This project is ideal for: +This project is especially useful for teams and developers who need: -- Web and mobile developers building on Stellar -- Server-side services consuming Stellar account and transaction data -- Wallet providers that need reliable fee estimation and account summaries -- Applications requiring typed API responses via bundled TypeScript definitions +- Web and mobile apps that need Stellar account, transaction, and network data +- Backend services aggregating balances, reserves, activity, and risk signals +- Wallets and custodians that need fee estimates, multisig insights, and account health checks +- Developers building with TypeScript who want typed responses and a predictable API surface ---- - -## Key Features +### Highlights -- 🌐 **Network status and ledger health** -- πŸ’° **Dynamic fee estimation** for optimal transaction pricing -- πŸ‘₯ **Account detail aggregation** including balances, signers, and thresholds -- πŸ“œ **Paginated transaction history** and operation history per account -- πŸͺ™ **Asset metadata search** and issuer lookup -- 🚫 **Built-in security middleware** with rate limiting, helmet headers, CORS, and HPP -- πŸ§ͺ **Test coverage** using Jest and Supertest -- πŸ“¦ **Bundled TypeScript types** for safe integration in TypeScript projects +- 🌐 **Network and ledger health** for testnet and mainnet +- πŸ’Έ **Dynamic fee estimation** with surge and trend analysis +- πŸ‘€ **Comprehensive account summaries** including balances, reserves, signers, and risk signals +- πŸ“œ **Transaction and operation history** with batch transaction status checks +- πŸͺ™ **Asset metadata, holder analytics, supply views, and issuer verification** +- πŸ“Š **DEX, liquidity pool, and arbitrage insights** +- πŸ” **Built-in security and resilience** with rate limiting, Helmet, CORS, HPP, API key support, and caching +- ⚑ **Live streaming** through WebSocket and Server-Sent Events for ledgers, transactions, and payments +- 🧱 **Soroban contract inspection** for deployed contract metadata and storage +- πŸ§ͺ **Jest/Supertest coverage** and bundled TypeScript definitions --- ## Documentation -- [SDK Migration Guide](docs/sdk-migration.md) β€” migrating from the JavaScript SDK to the TypeScript SDK +- [SDK Migration Guide](docs/sdk-migration.md) β€” moving from the JavaScript SDK to the TypeScript SDK - [SDK README](sdk/README.md) β€” JavaScript client usage and method reference -- [Getting Started Guide](docs/getting-started.md) - Set up the project and make your first API calls -- [Error Reference](docs/error-reference.md) - All error types, status codes, and suggested fixes -- [Rate Limiting](docs/rate-limiting.md) - Default limits, configuration, response headers, and retry strategies -- [Frequently Asked Questions (FAQ)](FAQ.md) - Common setup and contribution questions +- [Getting Started Guide](docs/getting-started.md) β€” install, configure, and make your first API calls +- [Error Reference](docs/error-reference.md) β€” error types, status codes, and troubleshooting +- [Rate Limiting](docs/rate-limiting.md) β€” defaults, headers, and retry guidance +- [Frequently Asked Questions (FAQ)](FAQ.md) β€” common setup and contribution questions +- [Soroban guide](docs/soroban.md) β€” contract inspection endpoints and examples --- @@ -193,7 +194,7 @@ See [docs/soroban.md](docs/soroban.md) for a full walkthrough with curl examples --- -## Documentation +## Additional Documentation - [docs/soroban.md](docs/soroban.md) β€” Soroban contract endpoints: what Soroban is, how contract IDs work, and how to inspect deployed contracts via `/soroban/contract/:id` and `/soroban/contract/:id/storage`.