Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/content/Docs/api-documentation/console-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: "Deploy on Akash programmatically without managing wallets or priva

**Deploy on Akash programmatically using the Console Managed Wallet API.**

The Managed Wallet API allows you to create and manage deployments programmatically without managing your own wallet or private keys.
The Managed Wallet API is part of the **Console API**: it lets you create and manage deployments with Console-managed wallets (no private keys). For querying the blockchain directly, use [Node API Layer](/docs/node-operators/architecture/api-layer)—the Console API is not an Akash node.

---

Expand Down
60 changes: 36 additions & 24 deletions src/content/Docs/api-documentation/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,76 +7,88 @@ linkTitle: "Getting Started"
description: "Integrate Akash Network into your applications with SDKs and APIs"
---

**Programmatic access to Akash Network with blockchain SDKs, deployment REST APIs, or public data endpoints.**
**Programmatic access to Akash Network: query the chain directly, use indexed data and managed wallets, or integrate with the chain SDK.**

Choose your integration method:
- **Akash Blockchain SDK** - Full blockchain integration with AKT/USDC payments
- **Akash Deployment REST API** - Simple REST API with credit card payments
- **Akash REST API** - Public endpoints for querying providers and GPU availability
Choose the right API for your use case:

- **Blockchain REST/RPC** — Query data from the chain directly (gRPC, REST, RPC on an Akash node). Use this when your app needs to read chain state or submit transactions to the blockchain.
- **Console API** — Query indexed data (stats, deployments, providers) and manage deployments for Console managed wallets. This is **not** a node: it serves aggregated/indexed data and managed-wallet flows, not raw chain queries.
- **Chain SDK** — Integrate with Akash in Go or TypeScript/JavaScript. Use your own wallet (AKT/USDC) or custodial flows.

---

## Blockchain REST/RPC (query the chain directly)

Query blockchain state and submit transactions via an Akash node. Use this when you need to read chain data (balances, deployments, validators, etc.) or broadcast transactions — not when you only need indexed stats or managed-wallet deployments.

- **[Node API Layer](/docs/node-operators/architecture/api-layer)** — gRPC, REST (gRPC-Gateway), and CometBFT RPC on an Akash node
- Run your own node or use a public RPC endpoint to query the chain directly

## Akash Blockchain SDK

Build deployment and provider management capabilities directly into your applications:
Build deployment and provider management into your app with the official chain SDK (Go and TypeScript/JavaScript). Integrate with the blockchain using your own wallet or custodial wallets; pay with AKT or USDC.

- **[Akash SDK](/docs/api-documentation/sdk)** - Official Go and JavaScript/TypeScript SDKs
- **[Installation Guide](/docs/api-documentation/sdk/installation)** - Get started with SDK installation
- **[Quick Start](/docs/api-documentation/sdk/quick-start)** - Deploy your first application programmatically
- **[API Reference](/docs/api-documentation/sdk/api-reference)** - Complete SDK documentation
- **[Examples](/docs/api-documentation/sdk/examples)** - Code examples for common tasks

## Akash Deployment REST API

Deploy to Akash using credit cards instead of crypto:
## Console API (indexed data & managed wallets)

- **[Managed Wallet API](/docs/api-documentation/console-api)** - REST API for credit card deployments via Console
- No wallet management required - Console handles the blockchain layer
- Pay with credit card instead of AKT or USDC
The Console API serves **indexed data** (providers, stats, deployments) and **managed wallet** deployment flows. It is **not** an Akash node — do not use it to query chain state or broadcast transactions. Use it for dashboards, provider/GPU discovery, and credit-card deployments via Console.

## Akash REST API
**Indexed data (read-only, no auth):**

Query Akash Network data without authentication:

- **[REST API Overview](/docs/api-documentation/rest-api)** - Public endpoints for network data
- **[Console API — Network Data](/docs/api-documentation/rest-api)** - Public endpoints for providers, GPU availability, and network statistics (indexed data; base URL: `console-api.akash.network`)
- **[Providers API](/docs/api-documentation/rest-api/providers-api)** - List and query provider details, hardware specs, and availability
- **[GPU Availability Guide](/docs/api-documentation/rest-api/gpu-availability-guide)** - Find GPU resources across the network

**Managed wallets (API key required):**

- **[Managed Wallet API](/docs/api-documentation/console-api)** - Create and manage deployments with Console-managed wallets; pay with credit card. No wallet or private key management.

---

## Use Cases

### When to Use Akash Blockchain SDK
### When to use Blockchain REST/RPC (node)
- Your app needs to query chain state (balances, deployments, validators, etc.) directly
- You need to broadcast transactions to the chain
- You are building tooling that talks to an Akash node (gRPC, REST, or RPC)

### When to use the Akash Blockchain SDK
- Full blockchain integration with your own wallet
- Pay with AKT or USDC cryptocurrency
- Build deployment automation tools
- Create custom deployment workflows
- Build provider management dashboards
- Develop monitoring and analytics tools

### When to Use Akash Deployment REST API
### When to use Console API (managed wallets)
- Accept credit card payments for deployments
- Deploy without managing wallets or crypto
- Build SaaS platforms that need simple payments
- Create user-friendly deployment interfaces
- Offer Akash deployments to non-crypto users

### When to Use Akash REST API
- Query provider availability, hardware specs, and GPU models
### When to use Console API (indexed network data)
- Query provider availability, hardware specs, and GPU models (indexed data)
- Build network dashboards and analytics tools
- Monitor provider uptime and capacity
- Find GPU resources for your workloads
- No authentication or payment setup needed
- No authentication or payment setup needed (public read-only endpoints)

---

## Getting Started

**Choose your integration method:**

- **Blockchain integration?** → [Use the Blockchain SDK](/docs/api-documentation/sdk) - Pay with AKT/USDC, manage your own wallet
- **Credit card payments?** → [Use the Deployment REST API](/docs/api-documentation/console-api) - No wallet needed, pay with credit card
- **Query network data?** → [Use the REST API](/docs/api-documentation/rest-api) - Public endpoints, no authentication required
- **Query the chain directly (node)?** → [Node API Layer](/docs/node-operators/architecture/api-layer) - gRPC, REST, RPC on an Akash node
- **Blockchain integration in code?** → [Use the Blockchain SDK](/docs/api-documentation/sdk) - Pay with AKT/USDC, manage your own wallet
- **Credit card deployments?** → [Managed Wallet API](/docs/api-documentation/console-api) - No wallet needed, pay with credit card via Console
- **Indexed network data (providers, GPU, stats)?** → [Console API — Network Data](/docs/api-documentation/rest-api) - Public endpoints, not a node

**Need help?**

Expand Down
15 changes: 9 additions & 6 deletions src/content/Docs/api-documentation/rest-api/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
categories: ["API Documentation", "REST API"]
tags: ["REST API", "Providers", "GPU", "Public API"]
tags: ["REST API", "Providers", "GPU", "Public API", "Console API"]
weight: 4
title: "Akash REST API"
linkTitle: "Akash REST API"
description: "Public REST API endpoints for querying Akash Network data including providers and GPU availability"
title: "Console API — Network Data"
linkTitle: "Console API — Network Data"
description: "Public Console API endpoints for indexed network data: providers, GPU availability, and statistics (not a node)"
---

**Public, read-only endpoints for querying Akash Network data. No authentication required.**
**Public, read-only Console API for indexed network data. No authentication required.**

This API serves **indexed data** (providers, GPU availability, network stats). It is **not** an Akash node — do not use it to query chain state or broadcast transactions. For querying the blockchain directly, use [Node API Layer (gRPC, REST, RPC)](/docs/node-operators/architecture/api-layer).

Base URL: `https://console-api.akash.network`

Expand Down Expand Up @@ -42,9 +44,10 @@ curl https://console-api.akash.network/v1/providers/akash1u5cdg7k3gl43mukca4aeul

## Key Features

- **Indexed data, not a node** — Aggregated network data from Console; for raw chain queries use [Node API Layer](/docs/node-operators/architecture/api-layer)
- **No authentication** — All endpoints are public and read-only
- **JSON responses** — Standard REST API returning JSON
- **Provider data** — Hardware specs, GPU models, uptime, location, and real-time capacity
- **Provider data** — Hardware specs, GPU models, uptime, location, and real-time capacity (indexed)
- **Network statistics** — Active/available/pending resources across the network

---
Expand Down
39 changes: 30 additions & 9 deletions src/pages/docs/api-documentation/getting-started.astro
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,38 @@ const integrationOptions = [
},
],
},
{
icon: codeIcon,
title: "Blockchain REST/RPC",
description: "Query the chain directly via an Akash node (gRPC, REST, RPC). For chain state and transactions.",
link: "/docs/node-operators/architecture/api-layer",
linkText: "Node API Layer →",
details: [
{
label: "Best for:",
items: [
"Querying chain state (balances, deployments, validators)",
"Submitting transactions to the blockchain",
"Tooling that talks to an Akash node",
],
},
{
label: "Note:",
text: "Use a node endpoint; Console API is indexed data, not a node.",
},
],
},
{
icon: globeIcon,
title: "Akash REST API",
description: "Query Akash Network data including providers, GPU availability, and network statistics",
title: "Console API — Network Data",
description: "Indexed data only: providers, GPU availability, stats. Not a node — do not use for chain queries.",
link: "/docs/api-documentation/rest-api",
linkText: "Explore REST API →",
linkText: "Explore Console API (network data) →",
details: [
{
label: "Best for:",
items: [
"Querying provider availability and specs",
"Querying provider availability and specs (indexed)",
"Finding GPU resources on the network",
"Building dashboards and analytics",
"Network monitoring tools",
Expand Down Expand Up @@ -136,12 +157,12 @@ const sdkDocsCards = [
},
];

// Akash REST API Documentation Cards
// Console API — Network Data (indexed) Documentation Cards
const restApiCards = [
{
icon: globeIcon,
title: "REST API Overview",
description: "Public endpoints for querying Akash Network data",
title: "Console API — Network Data",
description: "Indexed data: providers, GPU, stats. Not a node.",
link: "/docs/api-documentation/rest-api",
},
{
Expand Down Expand Up @@ -325,10 +346,10 @@ const helpLinks = [
</div>
</div>

<!-- Akash REST API Documentation -->
<!-- Console API — Network Data (indexed) -->
<div class="mt-12">
<h2 class="mb-6 text-2xl font-bold text-foreground md:text-3xl">
Akash REST API Documentation
Console API — Network Data (indexed)
</h2>
<div class="grid grid-cols-1 gap-4 lg:grid-cols-3">
{
Expand Down
Loading