🔌API Reference

API Reference for Secured Finance protocols

Secured Finance provides GraphQL APIs via The Graph protocol to query data from our smart contracts. This section documents how to use these APIs to access data from our protocols.

What You'll Learn

• How to query data from the Fixed-Rate Lending protocol

• Examples of common queries and their responses

• How to use GraphQL to build custom queries

• How to use our interactive API documentation with "Test It" functionality

Key Components

Subgraphs

Secured Finance maintains subgraphs for its protocols:

• Fixed-Rate Lending Subgraph - For querying data from the Fixed-Rate Lending protocol

Note: The USDFC Subgraph is currently under development and not yet deployed. USDFC data is only available through the USDFC SDK.

Available Networks

Our subgraphs are deployed on the following networks:

Protocol	Ethereum	Arbitrum	Filecoin
Fixed-Rate Lending	✅	✅	✅

Note: The USDFC Subgraph is currently under development and not yet deployed. USDFC data is only available through the USDFC SDK on the Filecoin network.

Subgraph Endpoints

These are Subgraph endpoint URLs for our production Mainnet and Testnet environments. You can click the URL and try some queries on the GraphQL playground.

Fixed-Rate Lending Subgraph

Ethereum

• Mainnet: https://api.studio.thegraph.com/query/64582/sf-prd-mainnet/version/latest

• Sepolia: https://api.studio.thegraph.com/query/64582/sf-prd-sepolia/version/latest

Arbitrum

• Mainnet: https://api.studio.thegraph.com/query/64582/sf-prd-arbitrum-one/version/latest

• Sepolia: https://api.studio.thegraph.com/query/64582/sf-prd-arbitrum-sepolia/version/latest

Filecoin

• Mainnet: https://api.goldsky.com/api/public/project_cm8i6ca9k24d601wy45zzbsrq/subgraphs/sf-filecoin-mainnet/0.0.3/gn

Note: The Filecoin Calibration testnet endpoints are not provided yet.

Getting Started

If you're new to GraphQL or The Graph, check out our introduction to subgraphs in the next sections. If you're already familiar with these technologies, you can jump directly to the specific subgraph documentation.

The Graph is a decentralized protocol for indexing and querying blockchain data, making it easier to query the difficult-to-read data stored on the blockchain. The Graph's decentralized approach ensures resilience, eliminating the need for centralized and resource-intensive alternatives.

To view the source of our subgraphs, visit our GitHub Repository.

Interactive API Documentation

We provide interactive API documentation for our Fixed-Rate Lending Subgraph using GitBook's OpenAPI integration. This allows you to explore and test the API directly from the documentation page in real-time.

Query the Fixed-Rate Lending Subgraph

post

Execute a GraphQL query against the Fixed-Rate Lending Subgraph

Body

querystringRequired

GraphQL query to execute

Example: { lendingMarkets( where: { isActive: true }, orderBy: maturity, orderDirection: asc, first: 10 ) { id currency maturity isActive openingUnitPrice lastLendUnitPrice lastBorrowUnitPrice volume } }

variablesobjectOptional

Variables for the GraphQL query (optional)

Responses

200

Successful response

application/json

post

HTTPcURLJavaScriptPython

POST /query/64582/sf-prd-arbitrum-sepolia/version/latest/ HTTP/1.1
Host: api.studio.thegraph.com
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "query": "{\n  lendingMarkets(\n    where: { isActive: true },\n    orderBy: maturity,\n    orderDirection: asc,\n    first: 10\n  ) {\n    id\n    currency\n    maturity\n    isActive\n    openingUnitPrice\n    lastLendUnitPrice\n    lastBorrowUnitPrice\n    volume\n  }\n}\n"
}

Get Active Lending MarketsGet Order Book for a MarketGet User TransactionsGet User DepositsGet Transaction Candle Sticks for Market AnalysisGet Taker Volumes By Currency

200

Successful response

{
  "data": {
    "lendingMarkets": [
      {
        "id": "0x123...",
        "currency": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "maturity": "1735689600",
        "isActive": true,
        "openingUnitPrice": "9900",
        "lastLendUnitPrice": "9830",
        "lastBorrowUnitPrice": "9870",
        "volume": "1000000000000"
      },
      {
        "id": "0x456...",
        "currency": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
        "maturity": "1735689600",
        "isActive": true,
        "openingUnitPrice": "9850",
        "lastLendUnitPrice": "9780",
        "lastBorrowUnitPrice": "9820",
        "volume": "500000000000"
      }
    ]
  }
}

The interactive documentation above allows you to:

1. Explore available endpoints and operations

2. View request and response schemas

3. Try out API calls directly from the documentation using the "Test It" feature

4. See example queries and responses

Using the Interactive Documentation

1. Browse through the available operations

2. Click on an operation to expand it

3. View the request parameters and example values

4. Click "Test It" to execute a request against the selected server

5. View the response directly in the documentation

For more complex queries, you can also use The Graph's Playground interface by visiting the subgraph endpoints directly.

Related Resources

• The Graph Documentation

• GraphQL Documentation

• Secured Finance GitHub Repositories