Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IPFS Routing API

The Routing API from IPFS — 5 operation(s) for routing.

IPFS Routing API is one of 40 APIs that IPFS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Routing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 5 operations across 5 paths. It is described by OpenAPI 3.0.0, at version v0.

Requests are made against 3 base URLs: http://localhost:5001, http://127.0.0.1:5001, https://ipfs.infura.io:5001.

5 operations 5 paths 0 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v0
Base URL
http://localhost:5001
Resource Areas
1

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Routing 5
POST
/api/v0/routing/findpeer
Find the multiaddresses associated with a Peer ID.
routing/findpeer 2 params → 200
POST
/api/v0/routing/findprovs
Find peers that can provide a specific value, given a key.
routing/findprovs 3 params → 200
POST
/api/v0/routing/get
Given a key, query the routing system for its best value.
routing/get 1 param → 200
POST
/api/v0/routing/provide
Announce to the network that you are providing given values.
routing/provide 3 params → 200
POST
/api/v0/routing/put
Write a key/value pair to the routing system.
routing/put 1 param body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ipfs-routing-api-openapi.yml Raw ↑

Other APIs IPFS publishes across the network.

IPFS HTTP Gateway API
IPFS Delegated Routing V1 HTTP API
IPFS Add API
IPFS Bitswap API
IPFS Block API
IPFS Bootstrap API
IPFS Cat API
IPFS Cid API
IPFS Commands API
IPFS Config API
IPFS Dag API
IPFS Dht API