API Reference

Detailed reference for Flowent’s API calls helps you integrate seamlessly.

Here's a GitBook-style API reference page for getCredits:


getCredits API Reference

Endpoint

GET https://api.flowent.com/v1/getCredits

Description

The getCredits endpoint returns the remaining API credits, details of the last 5 calls, and information about query usage, including sources.

Request

Headers

Header
Type
Description

flowent-key

String

Your Flowent API key.

Accept

String

application/json.

Example Request

curl -X GET "https://api.flowent.com/v1/getCredits" \
     -H "flowent-key: YOUR_API_KEY" \
     -H "Accept: application/json"

Response

Successful Response

{
  "remainingCredits": 23822,
  "lastCalls": [
    {
      "timestamp": "2025-01-29T10:45:00Z",
      "creditsUsed": 320,
      "query": "What's the latest NFT trend in Ethereum?'",
      "sources": ["coingecko", "opensea"]
    },
    {
      "timestamp": "2025-01-29T10:30:00Z",
      "creditsUsed": 427,
      "query": "Is the market bearish?",
      "sources": ["dune", "alternative", "coinmarketcap"]
    }
  ]
}

Response Fields

Field
Type
Description

remainingCredits

Integer

The number of credits left in your API plan.

lastCalls

Array

The last 5 API calls made.

timestamp

String

The UTC timestamp of the request.

creditsUsed

Integer

The number of credits consumed by the request.

query

String

The query executed in the request.

sources

Array

The data sources used in the query.

Example Error Response

{
  "error": "Invalid API Key"
}

Notes

  • This endpoint helps track API usage by providing details on recent queries and the sources used.

  • Ensure your API key is valid and has sufficient credits before making requests.

Would you like any modifications or additional details? 🚀


Last updated