# @helia/delegated-routing-v1-http-api-client
[](https://ipfs.tech)
[](https://discuss.ipfs.tech)
[](https://codecov.io/gh/ipfs/helia-delegated-routing-v1-http-api)
[](https://github.com/ipfs/helia-delegated-routing-v1-http-api/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
> A Delegated Routing V1 HTTP API client
# About
A client implementation of the IPFS [Delegated Routing V1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/) that can be used to interact with any compliant server implementation.
## Example
```typescript
import { delegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
import { CID } from 'multiformats/cid'
import { defaultLogger } from '@libp2p/logger'
const client = delegatedRoutingV1HttpApiClient({
url: 'https://example.org'
})({
logger: defaultLogger()
})
for await (const prov of client.getProviders(CID.parse('QmFoo'))) {
// ...
}
```
### How to use with libp2p
The client can be configured as a libp2p service, this will enable it as both a ContentRouting and a PeerRouting implementation
## Example
```typescript
import { delegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
import { createLibp2p } from 'libp2p'
import { peerIdFromString } from '@libp2p/peer-id'
const libp2p = await createLibp2p({
// other config here
services: {
delegatedRouting: delegatedRoutingV1HttpApiClient({
url: 'https://example.org'
})
}
})
// later this will use the configured HTTP gateway
await libp2p.peerRouting.findPeer(peerIdFromString('QmFoo'))
```
### Caching
By default, the client caches successful (200) delegated routing responses in browser environments (that support the [Cache API](https://developer.mozilla.org/en-US/docs/Web/API/Cache)) for a duration of 5 minutes. The client does this by adding an `x-cache-expires` header to the response object.
If caching is enabled, the client will cache responses for the duration of `cacheTTL` milliseconds.
If `cacheTTL` is 0, caching is disabled:
## Example
```typescript
// disable caching
const client = delegatedRoutingV1HttpApiClient({
url: 'https://example.org'
cacheTTL: 0
})({
logger: defaultLogger()
})
```
### Filtering with IPIP-484
The client can be configured to pass filter options to the delegated routing server as defined in IPIP-484.
The filter options be set globally, by passing them to the client constructor, or on a per-request basis.
## Example
```typescript
import { delegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
import { createLibp2p } from 'libp2p'
import { peerIdFromString } from '@libp2p/peer-id'
import { defaultLogger } from '@libp2p/logger'
// globally set filter options
const client = delegatedRoutingV1HttpApiClient({
url: 'https://delegated-ipfs.dev',
filterProtocols: ['transport-bitswap', 'unknown', 'transport-ipfs-gateway-http'],
filterAddrs: ['webtransport', 'webrtc-direct', 'wss']
})({
logger: defaultLogger()
})
// per-request filter options
for await (const prov of client.getProviders(CID.parse('bafy'), {
filterProtocols: ['transport-ipfs-gateway-http'],
filterAddrs: ['!p2p-circuit']
})) {
// ...
}
```
# Install
```console
$ npm i @helia/delegated-routing-v1-http-api-client
```
# API Docs
-
# License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/main/packages/client/LICENSE-APACHE) / )
- MIT ([LICENSE-MIT](https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/main/packages/client/LICENSE-MIT) / )
# Contribute
Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-delegated-routing-v1-http-api/issues).
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)