You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/Docs/api-documentation/console-api/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ description: "Deploy on Akash programmatically without managing wallets or priva
9
9
10
10
**Deploy on Akash programmatically using the Console Managed Wallet API.**
11
11
12
-
The Managed Wallet API allows you to create and manage deployments programmatically without managing your own wallet or private keys.
12
+
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.
Copy file name to clipboardExpand all lines: src/content/Docs/api-documentation/getting-started/index.md
+36-24Lines changed: 36 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,76 +7,88 @@ linkTitle: "Getting Started"
7
7
description: "Integrate Akash Network into your applications with SDKs and APIs"
8
8
---
9
9
10
-
**Programmatic access to Akash Network with blockchain SDKs, deployment REST APIs, or public data endpoints.**
10
+
**Programmatic access to Akash Network: query the chain directly, use indexed data and managed wallets, or integrate with the chain SDK.**
11
11
12
-
Choose your integration method:
13
-
-**Akash Blockchain SDK** - Full blockchain integration with AKT/USDC payments
14
-
-**Akash Deployment REST API** - Simple REST API with credit card payments
15
-
-**Akash REST API** - Public endpoints for querying providers and GPU availability
12
+
Choose the right API for your use case:
13
+
14
+
-**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.
15
+
-**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.
16
+
-**Chain SDK** — Integrate with Akash in Go or TypeScript/JavaScript. Use your own wallet (AKT/USDC) or custodial flows.
16
17
17
18
---
18
19
20
+
## Blockchain REST/RPC (query the chain directly)
21
+
22
+
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.
23
+
24
+
-**[Node API Layer](/docs/node-operators/architecture/api-layer)** — gRPC, REST (gRPC-Gateway), and CometBFT RPC on an Akash node
25
+
- Run your own node or use a public RPC endpoint to query the chain directly
26
+
19
27
## Akash Blockchain SDK
20
28
21
-
Build deployment and provider management capabilities directly into your applications:
29
+
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.
22
30
23
31
-**[Akash SDK](/docs/api-documentation/sdk)** - Official Go and JavaScript/TypeScript SDKs
24
32
-**[Installation Guide](/docs/api-documentation/sdk/installation)** - Get started with SDK installation
25
33
-**[Quick Start](/docs/api-documentation/sdk/quick-start)** - Deploy your first application programmatically
-**[Examples](/docs/api-documentation/sdk/examples)** - Code examples for common tasks
28
36
29
-
## Akash Deployment REST API
30
-
31
-
Deploy to Akash using credit cards instead of crypto:
37
+
## Console API (indexed data & managed wallets)
32
38
33
-
-**[Managed Wallet API](/docs/api-documentation/console-api)** - REST API for credit card deployments via Console
34
-
- No wallet management required - Console handles the blockchain layer
35
-
- Pay with credit card instead of AKT or USDC
39
+
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.
36
40
37
-
## Akash REST API
41
+
**Indexed data (read-only, no auth):**
38
42
39
-
Query Akash Network data without authentication:
40
-
41
-
-**[REST API Overview](/docs/api-documentation/rest-api)** - Public endpoints for network data
43
+
-**[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`)
42
44
-**[Providers API](/docs/api-documentation/rest-api/providers-api)** - List and query provider details, hardware specs, and availability
43
45
-**[GPU Availability Guide](/docs/api-documentation/rest-api/gpu-availability-guide)** - Find GPU resources across the network
44
46
47
+
**Managed wallets (API key required):**
48
+
49
+
-**[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.
50
+
45
51
---
46
52
47
53
## Use Cases
48
54
49
-
### When to Use Akash Blockchain SDK
55
+
### When to use Blockchain REST/RPC (node)
56
+
- Your app needs to query chain state (balances, deployments, validators, etc.) directly
57
+
- You need to broadcast transactions to the chain
58
+
- You are building tooling that talks to an Akash node (gRPC, REST, or RPC)
59
+
60
+
### When to use the Akash Blockchain SDK
50
61
- Full blockchain integration with your own wallet
51
62
- Pay with AKT or USDC cryptocurrency
52
63
- Build deployment automation tools
53
64
- Create custom deployment workflows
54
65
- Build provider management dashboards
55
66
- Develop monitoring and analytics tools
56
67
57
-
### When to Use Akash Deployment REST API
68
+
### When to use Console API (managed wallets)
58
69
- Accept credit card payments for deployments
59
70
- Deploy without managing wallets or crypto
60
71
- Build SaaS platforms that need simple payments
61
72
- Create user-friendly deployment interfaces
62
73
- Offer Akash deployments to non-crypto users
63
74
64
-
### When to Use Akash REST API
65
-
- Query provider availability, hardware specs, and GPU models
75
+
### When to use Console API (indexed network data)
description: "Public REST API endpoints for querying Akash Network data including providers and GPU availability"
5
+
title: "Console API — Network Data"
6
+
linkTitle: "Console API — Network Data"
7
+
description: "Public Console API endpoints for indexed network data: providers, GPU availability, and statistics (not a node)"
8
8
---
9
9
10
-
**Public, read-only endpoints for querying Akash Network data. No authentication required.**
10
+
**Public, read-only Console API for indexed network data. No authentication required.**
11
+
12
+
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).
-**Indexed data, not a node** — Aggregated network data from Console; for raw chain queries use [Node API Layer](/docs/node-operators/architecture/api-layer)
45
48
-**No authentication** — All endpoints are public and read-only
46
49
-**JSON responses** — Standard REST API returning JSON
0 commit comments