Unlock seamless data querying from the Enzyme Protocol with the new Enzyme API, designed to empower vault owners with streamlined access to vault activities that enables the development of innovative features and applications.
Introduction
The Enzyme API allows users to extract data from the Enzyme Protocol in a simple way. In particular, it provides methods to query data related to individual vaults, depositors, assets but also data related to the overall Enzyme network.
To further enhance the Enzyme API, we are building the Enzyme SDK which will enable methods to build transactions so that sophisticated trading strategies can be automated in a simple way.
While this initial launch offers access to the Enzyme API, we will continue to expand its functionality and use cases over the coming months. This offers several benefits to vault owners, most notably providing one single source of truth for all data related to a vault’s activity (including historical data). This data helps unlock multiple use cases, including customised reporting, streamlined accounting and automated trading.
If you are interested in using the Enzyme API, there are tools that can help non-native programmers extract data in a human-readable way. More information on this can be found in the “Tips and Tools” section.
With the release of the Enzyme API, we hope to provide our users with greater accessibility to Enzyme vault data and enable a range of new features, products and use cases.
How does the technology work?
The Enzyme API is a gRPC based API.
gRPC is a modern open source high performance Remote Procedure Call (RPC) framework that can run in any environment. It can efficiently connect services in and across data centres with pluggable support for load balancing, tracing, health checking and authentication. It is also applicable in the last mile of distributed computing to connect devices, mobile applications and browsers to backend services.
Using the Enzyme API
In order to use the Enzyme API, you will need an API key. API keys can be generated within the Enzyme App, https://app.enzyme.finance/account/api-tokens
Once you have created the API keys, there are two ways to use the Enzyme API: 1) using a pre-built API client, 2) sending standard HTTP requests to the API.
1. Using the Enzyme API client
Enzyme provides an API client package @enzymefinance/api which you can import into your JavaScript/TypeScript project. The client package runs both in the browser and in a node.js environment.
Client packages for other languages can be downloaded directly from the Buf Schema Registry at https://buf.build/avantgardefinance/enzyme/assets/main
We have built two simple examples on how to use the Enzyme API to get you started:
- Example browser usage: https://github.com/enzymefinance/sdk/tree/main/examples/example-api-web
- Example node usage: https://github.com/enzymefinance/sdk/tree/main/examples/example-api-node
2. Using HTTP request
If you cannot make use of the API client package, you can also send standard HTTP requests. A sample request looks as follows:
curl -X POST -H “content-type: application/json” -H “authorization: Bearer <API_TOKEN>” -H “connect-protocol-version: 1” -d ‘{“address”: “0x1b83ba4527c837d462d5b78d65a097dabae5ea89”}’ https://api.enzyme.finance/enzyme.enzyme.v1alpha.EnzymeService/GetVault
What use cases does the Enzyme API enable?
The Enzyme API opens up a myriad of possibilities for Enzyme vault owners and DeFi enthusiasts, ushering in an era of enhanced accessibility, transparency, and user empowerment. Some potential use cases include:
- Real-Time Vault Monitoring: By leveraging the API, vault owners can easily fetch real-time data related to their vaults. This information includes current asset holdings, asset allocation, performance metrics, and transaction history. This could streamline the monitoring process, aiding informed decision-making.
- Customised Reporting and Analytics: Vault owners can utilise the Enzyme API to generate customised reports and perform in-depth analysis, using data relevant to their specific strategies and goals. This could lead to more efficient risk management and the fine-tuning of investment strategies.
- Streamlined Accounting: Vault owners can utilise the Enzyme API to pull data directly into their accounting systems, automating the process of tracking inflows, outflows, and holdings across different assets. This can simplify the reconciliation process and provide a real-time view of the vault’s financial status. With accurate and easily accessible data, the API can help in maintaining proper accounting records, thereby easing the preparation of financial statements and tax filings.
- Integration with Third-Party Applications: The API enables developers to integrate Enzyme Protocol data into third-party applications, thus opening possibilities for new tools and services within the DeFi ecosystem. For example, performance tracking apps, financial dashboards, or DeFi analytics platforms could pull data from the Enzyme Protocol.
- Automated Trading and Asset Management: With the ability to fetch real-time and historical data, advanced users and developers can create automated trading systems or robo-advisors that respond to market conditions based on pre-set criteria. This could optimise trade execution and potentially enhance returns.
- Community Building and Transparency: By pulling data on vault activities, communities or groups of investors can build transparency into their investment operations. This could be particularly useful for decentralized autonomous organisations (DAOs) that operate funds collectively.
- Compliance and Auditing: Regulatory compliance and auditing is a significant concern for businesses operating in the crypto space. The Enzyme API could simplify this process by providing a reliable source of truth for all vault-related activities, supporting proof of compliance and facilitating auditing processes.
Remember, these are potential use cases. The actual applications will depend on the individual needs of vault owners and how they, or the developers they work with, choose to leverage the API’s capabilities.
Tools and Tips
We appreciate that using the Enzyme API may be daunting for some vault owners that are not programmers by background. As such, we’ve provided a number of different tips and tools to help make the process as seamless as possible.
Detailed Documentation: We’ve created comprehensive and easy-to-understand documentation for the Enzyme API. It provides step-by-step guidance on how to use the API, with explanations on each feature and function, in addition to providing examples. You can access it from the Buf Schema Registry.
API Client Package: We offer an API client package that you can easily import into your project. While this does involve some coding, the package is designed to simplify the process of interacting with the Enzyme API. Examples of how to use the package can be found in the GitHub links provided here and here.
HTTP Requests: If coding is a challenge, you can send standard HTTP requests to interact with the Enzyme API. This can be done using various simple tools like Postman, which provides a user-friendly interface to build and send requests.
Community Support: We encourage you to leverage our community of developers and users. They are often the best resource for answering questions and providing assistance. Our community can be found on platforms like Discord, where you can ask questions, share experiences, and learn from others.
Third-Party Tutorials: Many online platforms offer tutorials on how to work with APIs and gRPC, often in a user-friendly way. Websites like YouTube or learning platforms like Udemy or Coursera may have resources to help you understand how to interact with APIs in general, which can be applied to the Enzyme API.
Documentation
Technical documentation (endpoints and message definitions) is available from the Buf Schema Registry at https://buf.build/avantgardefinance/enzyme
Conclusion
The introduction of the Enzyme API marks an exciting milestone for the Enzyme community. It represents our commitment to providing a seamless, unified, and efficient way to access and manage on-chain data. With its intuitive design and broad capabilities, the API offers potential benefits to a wide range of users — from experienced developers eager to explore new DeFi applications, to vault owners looking to enhance their asset management strategies.
We’ve made every effort to make the Enzyme API as accessible as possible, providing comprehensive documentation, user-friendly tools, and a supportive community.
As we continue to evolve and improve our services, we look forward to seeing the innovative ways in which our users will leverage the Enzyme API. We believe it will be instrumental in driving greater transparency, flexibility, and efficiency within the DeFi landscape, shaping the future of on-chain asset management.
Remember, we are here to support your journey every step of the way. Don’t hesitate to reach out to our community for guidance, or share your experiences and ideas with us. If you have a particularly compelling idea, or you’d like to build products and services on top of Enzyme, you can read about the Enzyme Grant Programme here.
Together, we can continue to push the boundaries of what’s possible in the realm of decentralised finance.
