/pancake-info-api

Serverless API implementation for PancakeSwap on-chain data query.

Primary LanguageTypeScript

PancakeSwap API

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

v1 Documentation

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

v2 Documentation

The documentation of the endpoints, for PancakeSwap v2, 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