Using the UI

The Flux dashboard provides a user-friendly interface for creating APIs, managing settings, and tracking usage. This guide walks you through the main features.

Getting Started

Connecting Your Wallet

  1. Visit useflux.site

  2. Click Connect Wallet in the top right

  3. Select your wallet provider (MetaMask, Coinbase Wallet, or WalletConnect)

  4. Approve the connection in your wallet

  5. You're now logged in and can access the dashboard

Dashboard Overview

Once connected, you'll see the main dashboard with:

  • APIs — List of your created APIs

  • Create API — Button to add a new API

  • Usage Stats — Overview of calls and earnings

  • Settings — Account and payment preferences

Creating an API

Step 1: Basic Information

  1. Click Create API button

  2. Enter the API name (e.g., "Weather API")

  3. Add a description of what your API does

  4. Click Next

Step 2: Endpoint Configuration

  1. Enter your API endpoint URL (e.g., https://api.example.com/weather)

  2. Select the HTTP method (GET, POST, PUT, DELETE)

  3. Optionally add query parameters or request body examples

  4. Click Next

Step 3: Pricing and OpenAPI

  1. Set the price per request (in ETH or USDC)

  2. Select the currency (ETH or USDC)

  3. Choose the blockchain (Base, Polygon, or Ethereum)

  4. Upload or paste your OpenAPI specification

  5. Click Create API

Your API is now live and discoverable by consumers.

Managing Your APIs

View API Details

  1. Click on an API in your list

  2. See the API ID, endpoint, pricing, and usage statistics

  3. View the OpenAPI specification

  4. Check recent calls and earnings

Edit API Settings

  1. Click on an API

  2. Click Edit button

  3. Modify pricing, description, or endpoint

  4. Click Save Changes

Disable an API

  1. Click on an API

  2. Click Disable button

  3. The API will no longer accept requests

  4. Click Enable to reactivate

Delete an API

  1. Click on an API

  2. Click Delete button

  3. Confirm deletion

  4. The API is permanently removed

Tracking Usage and Earnings

Usage Dashboard

The main dashboard shows:

  • Total Calls — Number of API calls made

  • Total Earnings — Revenue from API calls

  • Active APIs — Number of enabled APIs

  • This Month — Current month's statistics

Detailed Call History

  1. Click on an API

  2. Scroll to Call History section

  3. See each call with:

    • Timestamp

    • Caller address

    • Payment amount

    • Response status

    • Request details

Export Data

  1. Click Export button on the dashboard

  2. Choose date range

  3. Select format (CSV or JSON)

  4. Download your data

Payment Settings

Configure Payment Address

  1. Click Settings in the top right

  2. Go to Payment Settings

  3. Your connected wallet address is your payment address

  4. All earnings are sent to this address

Supported Chains

Flux supports payments on:

  • Base — Fast, low-cost transactions

  • Polygon — Scalable, eco-friendly

  • Ethereum — Mainnet, highest security

You can receive payments on any chain. Consumers choose which chain to pay on.

Withdraw Earnings

Earnings are automatically sent to your wallet when consumers pay. No manual withdrawal needed.

API Discovery

How Consumers Find Your API

  1. Consumers visit the Flux dashboard

  2. They browse or search available APIs

  3. They see your API name, description, and pricing

  4. They can view your OpenAPI specification

  5. They can integrate with your API

Improving Discoverability

  1. Use clear, descriptive API names

  2. Write detailed descriptions

  3. Provide a complete OpenAPI specification

  4. Set competitive pricing

  5. Maintain high uptime and reliability

Troubleshooting

API Not Appearing in Discovery

Problem: Your API isn't showing up in the public list

Solutions:

  1. Verify the API is enabled (not disabled)

  2. Check that the endpoint is reachable

  3. Ensure the OpenAPI spec is valid

  4. Wait a few minutes for indexing

Calls Not Being Recorded

Problem: You're not seeing calls in your history

Solutions:

  1. Verify consumers are using the correct API ID

  2. Check that payment signatures are valid

  3. Ensure the target endpoint is responding

  4. Check browser console for errors

Payment Not Received

Problem: You made a call but didn't receive payment

Solutions:

  1. Verify the transaction was confirmed on-chain

  2. Check the payment amount matches your pricing

  3. Ensure your wallet address is correct

  4. Check blockchain explorer for transaction status

Best Practices

API Design

  • Keep endpoints simple and focused

  • Use clear, RESTful URL patterns

  • Return consistent response formats

  • Document all parameters and responses

Pricing Strategy

  • Start with competitive pricing

  • Consider your infrastructure costs

  • Monitor competitor pricing

  • Adjust based on demand

Reliability

  • Monitor API uptime

  • Set up alerts for failures

  • Test endpoints regularly

  • Maintain good response times

Security

  • Validate all inputs

  • Rate limit if needed

  • Use HTTPS for all endpoints

  • Keep API keys secure

Support

For issues or questions:

  1. Check the API Reference

  2. Review Authentication guide

  3. See Error Codes for troubleshooting

  4. Email: chirag@useflux.site

  5. Check GitHub issues

PreviousInstallationNextUsing the API

Last updated