\n\n# @helia/delegated-routing-v1-http-api-client\n\n[](https://ipfs.tech)\n[](https://discuss.ipfs.tech)\n[](https://codecov.io/gh/ipfs/helia-delegated-routing-v1-http-api)\n[](https://github.com/ipfs/helia-delegated-routing-v1-http-api/actions/workflows/js-test-and-release.yml?query=branch%3Amain)\n\n> A Delegated Routing V1 HTTP API client\n\n# About\n\n\n\nA 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.\n\n## Example\n\n```typescript\nimport { delegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'\nimport { CID } from 'multiformats/cid'\nimport { defaultLogger } from '@libp2p/logger'\n\nconst client = delegatedRoutingV1HttpApiClient({\n url: 'https://example.org'\n})({\n logger: defaultLogger()\n})\n\nfor await (const prov of client.getProviders(CID.parse('QmFoo'))) {\n // ...\n}\n```\n\n### How to use with libp2p\n\nThe client can be configured as a libp2p service, this will enable it as both a ContentRouting and a PeerRouting implementation\n\n## Example\n\n```typescript\nimport { delegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'\nimport { createLibp2p } from 'libp2p'\nimport { peerIdFromString } from '@libp2p/peer-id'\n\nconst libp2p = await createLibp2p({\n // other config here\n services: {\n delegatedRouting: delegatedRoutingV1HttpApiClient({\n url: 'https://example.org'\n })\n }\n})\n\n// later this will use the configured HTTP gateway\nawait libp2p.peerRouting.findPeer(peerIdFromString('QmFoo'))\n```\n\n### Caching\n\nBy 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.\n\nIf caching is enabled, the client will cache responses for the duration of `cacheTTL` milliseconds.\nIf `cacheTTL` is 0, caching is disabled:\n\n## Example\n\n```typescript\n// disable caching\nconst client = delegatedRoutingV1HttpApiClient({\n url: 'https://example.org'\n cacheTTL: 0\n})({\n logger: defaultLogger()\n})\n```\n\n### Filtering with IPIP-484\n\nThe client can be configured to pass filter options to the delegated routing server as defined in IPIP-484.\nThe filter options be set globally, by passing them to the client constructor, or on a per-request basis.\n\n## Example\n\n```typescript\nimport { delegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'\nimport { createLibp2p } from 'libp2p'\nimport { peerIdFromString } from '@libp2p/peer-id'\nimport { defaultLogger } from '@libp2p/logger'\n\n// globally set filter options\nconst client = delegatedRoutingV1HttpApiClient({\n url: 'https://delegated-ipfs.dev',\n filterProtocols: ['transport-bitswap', 'unknown', 'transport-ipfs-gateway-http'],\n filterAddrs: ['webtransport', 'webrtc-direct', 'wss']\n})({\n logger: defaultLogger()\n})\n\n// per-request filter options\nfor await (const prov of client.getProviders(CID.parse('bafy'), {\n filterProtocols: ['transport-ipfs-gateway-http'],\n filterAddrs: ['!p2p-circuit']\n})) {\n // ...\n}\n```\n\n# Install\n\n```console\n$ npm i @helia/delegated-routing-v1-http-api-client\n```\n\n## Browser `\n```\n\n# API Docs\n\n- \n\n# License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/main/packages/client/LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/main/packages/client/LICENSE-MIT) / )\n\n# Contribute\n\nContributions welcome! Please check out [the issues](https://github.com/ipfs/helia-delegated-routing-v1-http-api/issues).\n\nAlso 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.\n\nPlease 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).\n\nUnless 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.\n\n[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)\n","readmeFilename":"README.md"}
![\"Helia](\"https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png\")
\n \n