Skip to content

Fix/midnight docs #447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slowbackspace merged 2 commits into from
Apr 7, 2026
Merged

Fix/midnight docs #447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c670336
fix: redirect /midnight to /midnight/ to prevent broken css
slowbackspace Apr 7, 2026
8fd61c7
chore: midnight preview, preprod
slowbackspace Apr 7, 2026
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
8 changes: 5 additions & 3 deletions blockfrost-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,13 @@ info:

The Midnight Indexer API exposes a GraphQL API that enables clients to query and subscribe to blockchain data — blocks, transactions, contracts, and wallet-related events — indexed from the Midnight blockchain.

Available networks: `mainnet`, `preprod`, `preview`

| Service | URL | Protocol |
|---------|-----|----------|
| **Indexer HTTP API** | `https://midnight-mainnet.blockfrost.io/api/v0` | HTTP POST (GraphQL) |
| **Indexer Subscriptions API** | `wss://midnight-mainnet.blockfrost.io/api/v0/ws` | WebSocket |
| **Node RPC** | `https://rpc.midnight-mainnet.blockfrost.io` | JSON-RPC |
| **Indexer HTTP API** | `https://midnight-{network}.blockfrost.io/api/v0` | HTTP POST (GraphQL) |
| **Indexer Subscriptions API** | `wss://midnight-{network}.blockfrost.io/api/v0/ws` | WebSocket |
| **Node RPC** | `https://rpc.midnight-{network}.blockfrost.io` | JSON-RPC |


For the full documentation — queries, mutations, subscriptions, authentication options, and examples — see the Midnight GraphQL API Reference:
Expand Down
9 changes: 6 additions & 3 deletions docs/blockfrost-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,17 +312,20 @@ info:
wallet-related events — indexed from the Midnight blockchain.


Available networks: `mainnet`, `preprod`, `preview`


| Service | URL | Protocol |

|---------|-----|----------|

| **Indexer HTTP API** | `https://midnight-mainnet.blockfrost.io/api/v0` |
| **Indexer HTTP API** | `https://midnight-{network}.blockfrost.io/api/v0` |
HTTP POST (GraphQL) |

| **Indexer Subscriptions API** |
`wss://midnight-mainnet.blockfrost.io/api/v0/ws` | WebSocket |
`wss://midnight-{network}.blockfrost.io/api/v0/ws` | WebSocket |

| **Node RPC** | `https://rpc.midnight-mainnet.blockfrost.io` | JSON-RPC |
| **Node RPC** | `https://rpc.midnight-{network}.blockfrost.io` | JSON-RPC |



Expand Down
267 changes: 134 additions & 133 deletions docs/midnight/index.html
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 6 additions & 3 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,17 +312,20 @@ info:
wallet-related events — indexed from the Midnight blockchain.


Available networks: `mainnet`, `preprod`, `preview`


| Service | URL | Protocol |

|---------|-----|----------|

| **Indexer HTTP API** | `https://midnight-mainnet.blockfrost.io/api/v0` |
| **Indexer HTTP API** | `https://midnight-{network}.blockfrost.io/api/v0` |
HTTP POST (GraphQL) |

| **Indexer Subscriptions API** |
`wss://midnight-mainnet.blockfrost.io/api/v0/ws` | WebSocket |
`wss://midnight-{network}.blockfrost.io/api/v0/ws` | WebSocket |

| **Node RPC** | `https://rpc.midnight-mainnet.blockfrost.io` | JSON-RPC |
| **Node RPC** | `https://rpc.midnight-{network}.blockfrost.io` | JSON-RPC |



Expand Down
16 changes: 9 additions & 7 deletions spectaql.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ info:

- title: Endpoints
description: |
Blockfrost exposes three Midnight services:
Blockfrost exposes three Midnight services. Available networks: `mainnet`, `preprod`, `preview`.

| Service | URL |
|---------|-----|
| **Indexer API** | `https://midnight-mainnet.blockfrost.io/api/v0` |
| **Indexer WebSocket** | `wss://midnight-mainnet.blockfrost.io/api/v0/ws` |
| **Node RPC** | `https://rpc.midnight-mainnet.blockfrost.io` |
| **Indexer API** | `https://midnight-{network}.blockfrost.io/api/v0` |
| **Indexer WebSocket** | `wss://midnight-{network}.blockfrost.io/api/v0/ws` |
| **Node RPC** | `https://rpc.midnight-{network}.blockfrost.io` |

**Indexer API** — Send GraphQL queries and mutations over HTTP POST. This is the main entry point for fetching blockchain data (blocks, transactions, contracts, DUST status).

Expand All @@ -77,11 +77,13 @@ info:

Append `?project_id=YOUR_PROJECT_ID` to the endpoint URL. Use this when your client doesn't support setting custom headers (e.g. Midnight.js SDK).
```text
https://midnight-mainnet.blockfrost.io/api/v0?project_id=YOUR_PROJECT_ID
wss://midnight-mainnet.blockfrost.io/api/v0/ws?project_id=YOUR_PROJECT_ID
https://rpc.midnight-mainnet.blockfrost.io?project_id=YOUR_PROJECT_ID
https://midnight-{network}.blockfrost.io/api/v0?project_id=YOUR_PROJECT_ID
wss://midnight-{network}.blockfrost.io/api/v0/ws?project_id=YOUR_PROJECT_ID
https://rpc.midnight-{network}.blockfrost.io?project_id=YOUR_PROJECT_ID
```

Replace `{network}` with `mainnet`, `preprod`, or `preview`.

- title: Request Format
description: |
Send a POST request with a JSON body containing:
Expand Down
8 changes: 5 additions & 3 deletions src/definitions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,13 @@ info:

The Midnight Indexer API exposes a GraphQL API that enables clients to query and subscribe to blockchain data — blocks, transactions, contracts, and wallet-related events — indexed from the Midnight blockchain.

Available networks: `mainnet`, `preprod`, `preview`

| Service | URL | Protocol |
|---------|-----|----------|
| **Indexer HTTP API** | `https://midnight-mainnet.blockfrost.io/api/v0` | HTTP POST (GraphQL) |
| **Indexer Subscriptions API** | `wss://midnight-mainnet.blockfrost.io/api/v0/ws` | WebSocket |
| **Node RPC** | `https://rpc.midnight-mainnet.blockfrost.io` | JSON-RPC |
| **Indexer HTTP API** | `https://midnight-{network}.blockfrost.io/api/v0` | HTTP POST (GraphQL) |
| **Indexer Subscriptions API** | `wss://midnight-{network}.blockfrost.io/api/v0/ws` | WebSocket |
| **Node RPC** | `https://rpc.midnight-{network}.blockfrost.io` | JSON-RPC |


For the full documentation — queries, mutations, subscriptions, authentication options, and examples — see the Midnight GraphQL API Reference:
Expand Down
9 changes: 9 additions & 0 deletions vercel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"redirects": [
{
"source": "/midnight",
"destination": "/midnight/",
"permanent": true
}
]
}
Loading