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
134 changes: 134 additions & 0 deletions content/api/ar-io-node/admin.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
---
title: Admin
full: true
_openapi:
toc:
- depth: 2
title: Admin debugging information.
url: '#admin-debugging-information'
- depth: 2
title: Prioritize a transaction or bundle in the queue.
url: '#prioritize-a-transaction-or-bundle-in-the-queue'
- depth: 2
title: Queue a bundle for indexing, bypassing any filter settings by default.
url: '#queue-a-bundle-for-indexing-bypassing-any-filter-settings-by-default'
- depth: 2
title: Queue data items for indexing
url: '#queue-data-items-for-indexing'
- depth: 2
title: Get bundle processing status
url: '#get-bundle-processing-status'
- depth: 2
title: >-
Blocks transactions or data-items so your AR.IO Gateway will not serve
them.
url: >-
#blocks-transactions-or-data-items-so-your-ario-gateway-will-not-serve-them
- depth: 2
title: Blocks an ARNS name so your AR.IO Gateway will not serve it.
url: '#blocks-an-arns-name-so-your-ario-gateway-will-not-serve-it'
- depth: 2
title: Unblock an ARNS name.
url: '#unblock-an-arns-name'
- depth: 2
title: Export data to Parquet format
url: '#export-data-to-parquet-format'
- depth: 2
title: Get Parquet export status
url: '#get-parquet-export-status'
- depth: 2
title: Prune stable data items
url: '#prune-stable-data-items'
structuredData:
headings:
- content: Admin debugging information.
id: admin-debugging-information
- content: Prioritize a transaction or bundle in the queue.
id: prioritize-a-transaction-or-bundle-in-the-queue
- content: Queue a bundle for indexing, bypassing any filter settings by default.
id: queue-a-bundle-for-indexing-bypassing-any-filter-settings-by-default
- content: Queue data items for indexing
id: queue-data-items-for-indexing
- content: Get bundle processing status
id: get-bundle-processing-status
- content: >-
Blocks transactions or data-items so your AR.IO Gateway will not serve
them.
id: >-
blocks-transactions-or-data-items-so-your-ario-gateway-will-not-serve-them
- content: Blocks an ARNS name so your AR.IO Gateway will not serve it.
id: blocks-an-arns-name-so-your-ario-gateway-will-not-serve-it
- content: Unblock an ARNS name.
id: unblock-an-arns-name
- content: Export data to Parquet format
id: export-data-to-parquet-format
- content: Get Parquet export status
id: get-parquet-export-status
- content: Prune stable data items
id: prune-stable-data-items
contents:
- content: >-
Get detailed information about the current operational state of your
AR.IO Gateway, including information about any current warnings or
errors.
heading: admin-debugging-information
- content: >-
Stage a specific TX ID as priority for your Gateway to locate and
index. This will trigger and queue bundle processing if the
transaction is a bundle, and your Gateway is configured to unbundle
and index.
heading: prioritize-a-transaction-or-bundle-in-the-queue
- content: Queue a bundle for indexing, bypassing any filter settings by default.
heading: queue-a-bundle-for-indexing-bypassing-any-filter-settings-by-default
- content: >
Queue one or more data items for indexing. This endpoint

accepts an array of data item headers and prioritizes them for
processing.
heading: queue-data-items-for-indexing
- content: >
Returns detailed status information about a bundle's processing state,
including counts of data items,

processing timestamps, and retry attempts. This endpoint helps monitor
the progress and state of bundle

processing through the gateway's pipeline.
heading: get-bundle-processing-status
- content: >
Submits a TX ID/data-item ID or sha-256 content hash for content you
do not want your AR.IO Gateway to serve. Once submitted, your Gateway
will not respond to requests for these transactions or data-items.



WARNING - Testing a TX ID here WILL result in that data being blocked
by your Gateway.
heading: >-
blocks-transactions-or-data-items-so-your-ario-gateway-will-not-serve-them
- content: Blocks an ARNS name so your AR.IO Gateway will not serve it.
heading: blocks-an-arns-name-so-your-ario-gateway-will-not-serve-it
- content: Unblock an ARNS name so your AR.IO Gateway will serve it again.
heading: unblock-an-arns-name
- content: >
Initiates an export of data to Parquet format files. This process runs
in the background

and exports data for the specified block height range.
heading: export-data-to-parquet-format
- content: Returns the current status of the Parquet export process
heading: get-parquet-export-status
- content: >
Removes stable data items from the database that were indexed before
the specified timestamp.

This helps manage database size by removing older, stable data items.
heading: prune-stable-data-items
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Access several password protected features and functions specific to your AR.IO Gateway.


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/ar-io/admin/debug","method":"get"},{"path":"/ar-io/admin/queue-tx","method":"post"},{"path":"/ar-io/admin/queue-bundle","method":"post"},{"path":"/ar-io/admin/queue-data-item","method":"post"},{"path":"/ar-io/admin/bundle-status/{id}","method":"get"},{"path":"/ar-io/admin/block-data","method":"put"},{"path":"/ar-io/admin/block-name","method":"put"},{"path":"/ar-io/admin/unblock-name","method":"put"},{"path":"/ar-io/admin/export-parquet","method":"post"},{"path":"/ar-io/admin/export-parquet/status","method":"get"},{"path":"/ar-io/admin/prune-stable-data-items","method":"post"}]} webhooks={[]} hasHead={true} />
19 changes: 19 additions & 0 deletions content/api/ar-io-node/arns.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: ArNS
full: true
_openapi:
method: GET
route: /ar-io/resolver/{name}
toc: []
structuredData:
headings: []
contents:
- content: Get detailed information of a specified ArNS name.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Get data from the AR.IO Gateway Arweave Name System


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/ar-io/resolver/{name}","method":"get"}]} webhooks={[]} hasHead={true} />
24 changes: 24 additions & 0 deletions content/api/ar-io-node/blocks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Blocks
full: true
_openapi:
toc: []
structuredData:
headings: []
contents:
- content: >-
Get detailed information about the current block on the Arweave
network.
- content: Gets the current block height of the Arweave network.
- content: Get block information based on a block's hash.
- content: >-
Alternative endpoint to `/current_block`, gets current block
information.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Get current or historical Arweave block information


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/current_block","method":"get"},{"path":"/block/height/{height}","method":"get"},{"path":"/block/hash/{hash}","method":"get"},{"path":"/block/current","method":"get"}]} webhooks={[]} hasHead={true} />
20 changes: 20 additions & 0 deletions content/api/ar-io-node/chunks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Chunks
full: true
_openapi:
toc: []
structuredData:
headings: []
contents:
- content: Fetches information about the size and offset of a specified chunk.
- content: >-
Returns the same headers as GET but without the response body. Useful
for checking chunk existence and metadata.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Upload Arweave data chunks or get existing chunk offset information


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/chunk/{offset}","method":"get"},{"path":"/chunk/{offset}","method":"head"}]} webhooks={[]} hasHead={true} />
33 changes: 33 additions & 0 deletions content/api/ar-io-node/data.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Data
full: true
_openapi:
toc: []
structuredData:
headings: []
contents:
- content: >
Get the content of a specified transaction or data item. Supports
manifest path resolution,

range requests, and returns various informational headers about data
verification and caching status.
- content: >
Get the headers for a specified transaction or data item without the
content.

Returns the same headers as the GET request.
- content: >-
Get the raw content of a specified transaction without manifest
resolution
- content: Get the headers for raw transaction data without manifest resolution
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Core data retrieval operations for accessing transaction and data item content. Supports manifest resolution,
range requests, caching, and verification status. These endpoints serve as the primary interface for retrieving
data from the Permaweb.


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/{txId}","method":"get"},{"path":"/{txId}","method":"head"},{"path":"/raw/{txId}","method":"get"},{"path":"/raw/{txId}","method":"head"}]} webhooks={[]} hasHead={true} />
22 changes: 22 additions & 0 deletions content/api/ar-io-node/farcaster-frames.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Farcaster Frames
full: true
_openapi:
toc: []
structuredData:
headings: []
contents:
- content: >-
Responds to a Farcaster initial Frame GET request by returning the
content of a specified Arweave transaction or data item.
- content: >-
Responds to a Farcaster response Frame POST request by returning the
content of a specified Arweave transaction or data item.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieve and interact with Farcaster Frames using Arweave transactions.


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/local/farcaster/frame/{txId}","method":"get"},{"path":"/local/farcaster/frame/{txId}","method":"post"}]} webhooks={[]} hasHead={true} />
65 changes: 65 additions & 0 deletions content/api/ar-io-node/gateway.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: Gateway
full: true
_openapi:
toc: []
structuredData:
headings: []
contents:
- content: >
Returns either gateway information or serves content based on
configuration:


- If neither APEX_TX_ID nor APEX_ARNS_NAME is set, returns gateway
information

- If APEX_TX_ID is set, serves that transaction's content

- If APEX_ARNS_NAME is set, resolves and serves that ArNS name's
content


The Content-Type of the response will match the content type of the
transaction or ArNS-resolved data (e.g., text/html for HTML documents,
application/json for JSON documents, application/octet-stream for
binary data, etc.).
- content: Get the current health status of the AR.IO Gateway.
- content: |
Returns information about the AR.IO Gateway, including:
- Gateway wallet address
- Process ID
- ANS-104 filter configurations
- Supported manifest versions
- Gateway software release version
- content: >
Returns information about AR.IO Gateway peers and Arweave node peers.

For gateways, includes both data and chunk weights used for peer
selection.

Peer keys are formatted as host:port.
- content: >
Returns metrics in Prometheus format for monitoring the Gateway's
performance and status.

These metrics include various counters, gauges, and histograms
tracking:

- HTTP request statistics

- Transaction processing metrics

- System resource usage

- Cache performance

- Bundle processing statistics
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Operations related to the AR.IO Gateway server itself, including health checks, metrics, and gateway-specific information


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/","method":"get"},{"path":"/ar-io/healthcheck","method":"get"},{"path":"/ar-io/info","method":"get"},{"path":"/ar-io/peers","method":"get"},{"path":"/ar-io/__gateway_metrics","method":"get"}]} webhooks={[]} hasHead={true} />
33 changes: 33 additions & 0 deletions content/api/ar-io-node/index-querying.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Index Querying
full: true
_openapi:
method: POST
route: /graphql
toc: []
structuredData:
headings: []
contents:
- content: >
GraphQL endpoint for querying indexed transaction and block data.
Supports:

- Transaction queries by ID, owner, recipient, tags, and bundle

- Block queries by ID and height

- Pagination and sorting

- Rich metadata including sizes, content types, and signatures


See the GraphQL Playground at `/graphql` for full schema documentation
and interactive querying.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Get data from the AR.IO Gateway index using GQL


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/graphql","method":"post"}]} webhooks={[]} hasHead={true} />
22 changes: 22 additions & 0 deletions content/api/ar-io-node/network.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Network
full: true
_openapi:
toc: []
structuredData:
headings: []
contents:
- content: An alternative option for accessing network and Gateway status.
- content: >-
Gets a list of ip addresses for peers your Gateway is currently
connected with.
- content: Gets the current block height of the Arweave network.
- content: Get the current transaction anchor of the Arweave network.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Get Arweave node info, peers and nework status


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/info","method":"get"},{"path":"/peers","method":"get"},{"path":"/height","method":"get"},{"path":"/tx_anchor","method":"get"}]} webhooks={[]} hasHead={true} />
Loading