Yearn API is a collection of Serverless API endpoints focused on Yearn integrations.
Yearn API intentions are as follows:
- Provide free API endpoints to simplify 3rd party integration with Yearn
- Provide an "API playground" (Swagger UI) anyone can use to quickly browse and test available APIs
- Document all existing APIs
- Allow the entire API stack to be forked to enable community involvement in API development
- Install docker
- Execute terminal commands
git clone https://github.com/yearn-integrations/yearn-api.git
cd yearn-api
cp .env.example .env
docker-compose up
- The API should now be running locally on your dev machine
- .env.example contains sample API keys for various services (Infura/Etherscan). This is done to enable developers to get up to speed quickly. If you are planning on developing APIs that extensively utilize these keys please consider generating new API keys :)
- Update your .env file to use your own custom web3, archive node, and graph endpoints
- Update your .env file to use your own custom AWS Credentials
- Run the command
docker-compose upto test API endpoints locally - You can reach the API under localhost:3000
- If you want to change the local port, change the "ports" entry under "serverless" in the docker-compose.yml
- The dirs config, services and utils are mounted into the running container, so you code changes will become available instantly on the running instance
- If you want to change that, remove the "volumes" entries under "serverless" in the docker-compose.yml
- Currently three stages are available
prodis used for production deployments. Production endpoint is https://api.yearn.toolsdevis used for development purposes. Development endpoint is https://dev-api.yearn.toolsstagingis used for APIs pending production deployment. Staging endpoint is https://staging-api.yearn.tools
- Use the command
sls remove --stage devto remove all functions and custom domains associated with a stage
- Use the command
sls deploy --stage devto deploy - You can also deploy a single function using
sls deploy function -f functionName --stage dev