Skip to content

Microservice for searching the ipfs-search.com Elasticsearch index.

License

Notifications You must be signed in to change notification settings

ipfs-search/ipfs-search-api

Repository files navigation

ipfs-search.com search API

Maintainability Backers on Open Collective Sponsors on Open Collective

Microservice for searching the ipfs-search.com Elasticsearch index.

API Spec

swagger-api validator-badge

Documentation

Statically generated documentation for the API can be found in the docs folder and beautifully rendered interactive documentation is hosted at Swagger.

JavaScript/TypeScript client

There's a JavaScript/TypeScript client provided in the client folder and through npm.

Server

Open the server folder and run:

npm install
npm start

This will start an API server listening on port 9615, expecting Elasticsearh to be available on port 9200 on the localhost.