Skip to content

becoswap/becoswap-info-api

Repository files navigation

Becoswap API

The Becoswap API is a set of endpoints used by market aggregators (e.g. coinmarketcap.com) to surface Becoswap liquidity and volume information. All information is fetched from the underlying subgraphs.

Documentation

The documentation of the endpoints, for Becoswap, can be found here.

Development

Install requirements

yarn global add vercel

Build

# Install dependencies
yarn

# Build project
vercel dev

Endpoints are based on filename inside the api/ folder.

# api/pairs.ts
curl -X GET 'localhost:3000/api/pairs'

# ...

Production

Deploy

Deployments to production are triggered by a webhook when a commit, or a pull-request is merged to master.

If you need to force a deployment, use the following command:

vercel --prod

Releases

No releases published

Packages

No packages published