📡Developers
Last updated
Was this helpful?
The Frankencoin API provides comprehensive access to all data within the Frankencoin ecosystem. This RESTful API enables developers to integrate Frankencoin functionality into their applications, build analytics tools, monitor positions, and interact with the protocol programmatically.
https://api.frankencoin.comThe Frankencoin API is organized into several controllers, each serving specific data about different aspects of the ecosystem:
Ecosystem - Get information about the Frankencoin token, FPS, minters, and collateral
Positions - Manage and query collateralized lending positions
Challenges - Access liquidation challenge and auction data
Prices - Access price feeds and historical price data for collateral assets
Savings - Query savings module data, interest rates, and yields
Transfers - Track ZCHF transfers with custom reference messages
Analytics - Retrieve ecosystem-wide metrics and financial analytics
In general API responses are returned in JSON format. Most list endpoints follow a consistent structure:
or
Financial amounts in the API are typically represented as strings to preserve precision:
Token amounts are in wei (1e18 precision for 18-decimal tokens)
Timestamps are Unix epoch (seconds)
Interest rates are in PPM (parts per million, e.g., 20000 = 2%)
For interactive API exploration with request/response examples, visit the Swagger documentation:
The API currently has no rate limiting, but please use reasonable request rates to ensure fair access for all users.
For API questions or issues:
GitHub Smart Contracts: Frankencoin ZCHF
GitHub API NestJS: Frankencoin API
NPM Package for ABIs, Addresses, SupportedChains, ...: NPM Package Core
NPM Package for API Types, Return Types, ...: NPM Package API Types
Swagger Docs: api.frankencoin.com
Last updated
Was this helpful?
Was this helpful?
{
"num": 100,
"list": [...]
}{
"num": 100,
"addresses": [...],
"map": {...}
}https://api.frankencoin.com