pickle-api v1.0.0

PICKLE Serverless API

Collection of serverless API to enable public access to data surrounding the PICKLE protocol.

To deploy, run yarn deploy:prod.

Documentation

Swagger is used for documentation of the Pickle API. Two sets of hosted swagger documents are currently available:

• Brining Documentation
• Production Documentation

Brining documentation will have latest, in development API and will not be curated. This document makes no assurances it is accurate, a valid swagger doc, or otherwise not polluted with OPTIONS documentation. Production documentation will be curated with manual post processing of the Swagger JSON to ensure readibility. This document will capture the current production deployment of the API with guaranteed testable sandbox.

Jar Options

Jar path parameters are case sensitive and based on existing jar contracts.

• wbtc-eth
• dai-eth
• usdc-eth
• usdt-eth
• cdai
• 3poolcrv
• scrv
• renbtccrv

Contributing

Anyone is free to open a pull request to contribute to the API. Currently there are no open issues, as the repository evolves so will the contribution process. Feel free to open a pull request to help formalize contribution, update documentation, or provide feature requests.