Orca API is a REST API server that defines a user-friendly interface for Orca SDK. The Orca SDK contains a set of simple-to-use APIs to allow developers to integrate with Orca's decentralized exchange platform.
npm install# development
npm run start
# watch mode
npm run start:dev
# production mode
npm run start:prodWhen running locally, Orca API is accessible at http://0.0.0.0:3000.
# unit tests
npm run test
# e2e tests
npm run test:e2e
# test coverage
npm run test:covAll endpoints with detailed parameters and responses can be found at http://0.0.0.0:3000/docs/.
List all Orca pools.
Gauge funds allocated in designated pool.
Deposit funds to designated pool.
Withdraw funds from designated pool.
List all Orca farms.
Gauge funds allocated in designated farm.
Deposit funds to designated farm.
Withdraw funds from designated farm.
Swap tokens.
List account's portfolio.
List all tokens traded at Orca.
Apache License 2.0