Walrus Protocol routes API

The routes API from Walrus Protocol — 9 operation(s) for routes.

Documentation Provider Profile APIs.io OpenAPI GitHub

Walrus Protocol routes API is published by Walrus Protocol on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include routes. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 9 paths, and defines 19 schemas. It is described by OpenAPI 3.1.0, at version 1.52.1.

Requests are made against the base URL https://aggregator.walrus-mainnet.walrus.space.

10 operations 9 paths 19 schemas 7 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

1.52.1

Base URL

https://aggregator.walrus-mainnet.walrus.space

Contact

Mysten Labs

License

Apache-2.0

Resource Areas

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 7 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

routes 10

GET

/v1/blobs/by-object-id/{blob_object_id}

Retrieve a Walrus blob with its associated attribute.

get_blob_by_object_id 1 param → 200400403404416451500503

GET

/v1/blobs/by-quilt-id/{quilt_id}/{identifier}

Retrieve a patch from a Walrus quilt by its quilt ID and identifier.

get_patch_by_quilt_id_and_identifier 2 params → 200403404416451500503

GET

/v1/blobs/by-quilt-patch-id/{quilt_patch_id}

Retrieve a patch from a Walrus quilt by its quilt patch ID.

get_patch_by_quilt_patch_id 1 param → 200403404416451500503

GET

/v1/blobs/{blob_id}

Retrieve a Walrus blob.

get_blob 3 params → 200400403404416451500503

GET

/v1/blobs/{blob_id}/byte-range

Retrieve a specific byte range from a Walrus blob.

get_blob_byte_range 3 params → 200400403404451500

GET

/v1/quilts/{quilt_id}/patches

List patches in a quilt.

list_patches_in_quilt 1 param → 200403404416451500503

GET

/v1alpha/blobs/concat

Concatenate and stream multiple blobs via GET.

get_blobs_concat 2 params → 200400403404451500

POST

/v1alpha/blobs/concat

Concatenate and stream multiple blobs via POST.

post_blobs_concat body → 200400403404451500

PUT

/v1/blobs

Store a blob on Walrus.

put_blob 8 params body → 200400413451500504

PUT

/v1/quilts

Store multiple files as a quilt using multipart/form-data.

put_quilt 8 params body → 200400413451500504

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Blob (8 properties), StorageResource (4 properties), ConcatRequestBody (3 properties), QuiltPatchItem (3 properties). Each schema is shown below with its type and property counts.

EventOrObjectId

Either an event ID or an object ID.

u32

integer

StorageResource

object

Sui object for storage resources.

4 properties 4 required

Blob

object

Sui object for a blob.

8 properties 7 required

BlobId

string

The ID of a blob.

Status

object

A message returned from a failed API call. Contains both human-readable and machine-readable details of the error, to assist in resolving the error.

1 property 1 required

QuiltPatchItem

object

Response item for a patch in a quilt.

3 properties 3 required

QuiltPatchId

object

A QuiltPatchId is a globally unique id for a quilt patch. A quilt patch is a individual blob within a quilt.

2 properties 2 required

BlobStoreResult

Result when attempting to store a blob.

EventID

object

Schema for the [suitypes::event::EventID] type.

2 properties 2 required

RegisterBlobOp

The operation performed on blob and storage resources to register a blob.

StoredQuiltPatch

object

Identifies a stored quilt patch.

3 properties 2 required

SuiAddress

string

Sui address encoded as a hexadecimal string

ConcatRequestBody

object

The request body for concatenating multiple blobs via POST.

3 properties 1 required

ObjectID

string

Sui object ID as a hexadecimal string

Binary

string

EncodingType

string

Supported Walrus encoding types.

QuiltStoreResult

object

Result when attempting to store a quilt.

2 properties 2 required

ReadOptions

object

The query parameters for a read operation.

2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#routes

← Back to W APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Walrus Protocol routes API

Metadata

Paths & Operations 10

Schemas 19

Specification

Source

API Details

Provider

Explore more