Quick Start

Get up and running with Flux in under 5 minutes.

Prerequisites

  • A Web3 wallet (MetaMask, Coinbase Wallet, etc.)

  • Some ETH for gas fees (on Base, Polygon, or Ethereum)

  • An API you want to monetize

Step 1: Connect Your Wallet

  1. Click "Connect Wallet" in the top right

  2. Choose your wallet provider

  3. Approve the connection

Step 2: Create Your First API

  1. Navigate to the Dashboard

  2. Click "Create New API"

  3. Fill in the details:

    • Name: Your API name (e.g., "Weather API")

    • Base URL: Your API's base URL (e.g., https://api.weather.com)

    • Description: Brief description of what your API does

  4. Click "Next"

Step 3: Add Endpoints

For each endpoint you want to monetize:

  1. Endpoint Name: Descriptive name (e.g., "Get Current Weather")

  2. Method: HTTP method (GET, POST, etc.)

  3. Path Pattern: URL path (e.g., /current/:city)

  4. Price: Cost per request (e.g., 0.001 ETH)

  5. Payment Chain: Which blockchain to use (Base, Polygon, etc.)

  6. Recipient Address: Your wallet address to receive payments

Click "Add Endpoint" to add more, or "Next" to continue.

Step 4: Test Your Endpoint

Before publishing, test that your API is accessible:

  1. Click "Test First Endpoint"

  2. Review the test results

  3. If successful, click "Publish API"

Step 5: Share Your API

Your API is now live! Share it with users:

  1. Copy the API ID from your dashboard

  2. Share the portal link: https://useflux.site/portal/{apiId}

  3. Users can now pay and use your API!

Next Steps

Need Help?

Visit Flux Gateway to get started!

Last updated