Skip to content

octanolabs/shinobi-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Uniswap API

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

The API is designed around the CoinMarketCap requirements document.

Prefer the Uniswap subgraph for any Uniswap queries whenever possible. The respective subgraphs will always have more recent data.

V2 Subgraph: https://github.com/Uniswap/uniswap-v2-subgraph

V1 Subgraph: https://github.com/graphprotocol/uniswap-subgraph

Getting an API Key

Please fill out this form if you would like to get an API key.

Using an API Key

You can use an API key by setting it in the x-api-key header, like so:

curl -v --compressed https://api.uniswap.info/v2/tickers -H 'x-api-key: abcd1234'

Segregated data

Note the data returned by the V1 and V2 endpoints is segregated, i.e. there are no endpoints for combined data from both Uniswap V1 and V2.

V1 Documentation

The documentation of the /v1/ endpoints is here.

V2 Documentation

The documentation of the /v2/ endpoints is here.

Deploying the API

The API uses the serverless framework and can easily be deployed to any AWS account, via the yarn sls deploy command.

In order to configure your AWS account as a target, see the serverless docs.

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%