API

To reduce the friction of creating launchpads and launching tokens we have released an API, allowing builders to create their own launchpad contract and users to launch tokens via their launchpad with no-wallet/no-gas API calls.

There is no requirement for a wallet to be connected and instead a user can Flaunch a token connected to their email address, X (Twitter), Farcaster account or Base wallet address.

The account connected to the flaunched token will be able to connect to Flaunch, or any external flow, using Privy to have access to their launchpad fee or coin fee claims and offramp their fees into either crypto or fiat.

So whether you're extending your existing platform to benefit from token launches, or building a more generic plugin that an entire ecosystem can use, the Flaunch API should have ample logic to support you.

API Keys

No API keys are required for the use of the Web 2 API endpoint. If you are hitting the current rate limits reach out on discord for increased access.

Example Integration

To demonstrate the power of this API, we have put together a landing page that will allow for fast flaunching across multiple recipient types.

Flaunch Memecoin Creator

https://just.flaunch.gg/

Have you integrated the Flaunch API? Get in touch and we'll feature it here!

Available API Calls

Below we have documented the API calls that are available for the Memecoin API. These are also available as a Postman collection for quicker prototyping.

67KB

Flaunch Memecoin API.postman_collection.json

Download the Flaunch Memecoin API Postman Collection

Base API URI

https://web2-api.flaunch.gg/livez

Health Check

GET /livez

Checks if the API is running and returns the network configuration.

Headers

Name	Value
Content-Type	application/json

Response

[200] Success Response

{
  "status": "ok",
  "serverWallet": "0x4d7c5DFceC78E011E16BFe9F701D857841bbDFbB",
  "network": "base-sepolia"
}

Deploy a Revenue Manager (Launchpad)

POST /api/v1/{{ base | base-sepolia }}/create-revenue-manager

Required Fields

Name	Value
protocolFee	Protocol fee in basis points (0-10000, where 100 = 1%)

Fee Recipient Options (MUST choose one)

Name	Value
recipientAddress	Ethereum wallet address for the fee recipient
recipientEmail	Email address for the fee recipient
recipientTwitterUsername	Twitter username (without @ symbol)
recipientFarcasterUsername	Farcaster username (without the @ symbol)

Optional Fields

Name	Value
ownerAddress	Ethereum address that will own the revenue manager (defaults to fee recipient below)

Headers

Name	Value
Content-Type	application/json

Body

{
  "protocolFee": "1000",
  "recipientAddress": "0x498E93Bc04955fCBAC04BCF1a3BA792f01Dbaa96",
  "ownerAddress": "0xabcdef123456789abcdef123456789abcdef1234"
}

Response

[200] Success Response

{
    "success": true,
    "managerAddress": "0x57ac78c4a704233e274bbcdeb057ba640b65de23",
    "txHash": "0x171c6358fabc86337bfe6decc6d2d6fc2fe3ca9918a680ad36b5a71bec34e56e",
    "owner": "0x498E93Bc04955fCBAC04BCF1a3BA792f01Dbaa96",
    "recipientAddress": "0xF1a700000087c011413C21C9b357A6962Aa256f9",
    "protocolFee": 1000,
    "privy": null
}

[200] Success w/ Privy

{
    "success": true,
    "managerAddress": "0xe21ff18247e8816ab447c2f0eec087503105d948",
    "txHash": "0x3b2ea8464286ac85545de12cb7cbf0d56d37d5149855fcb9871337c2873ae6b8",
    "owner": "0x498E93Bc04955fCBAC04BCF1a3BA792f01Dbaa96",
    "recipientAddress": "0xDAc4A85d446B30F21a79c07097dc56Cd4A07E87b",
    "protocolFee": 1000,
    "privy": {
        "privyUserId": "did:privy:cm8prfp7700eh6kf1zduzfhsh",
        "walletAddress": "0xDAc4A85d446B30F21a79c07097dc56Cd4A07E87b"
    }
}

[500] Error Response

{
  "success": false,
  "error": "Invalid protocol fee. Must be a number between 0 and 10000 (0-100%)"
}

Image Upload

POST /api/v1/upload-image

Uploads and validates an image before creating a memecoin. Images are checked for appropriate content and stored on IPFS.

Rate Limit: Maximum 4 image uploads per minute per IP address.

Headers

Name	Value
Content-Type	application/json

Body

{
  // Base64 Encoded Image String (https://www.base64-image.de/)
  "base64Image": "data:image/jpeg;base64,/9j/4AAQSkZJRgAB...FwySj0f/2Q=="
}

Response

[200] Success Response

{
  "success": true,
  "ipfsHash": "QmX7UbPKJ7Drci3y6p6E8oi5TpUiG7NH3qSzcohPX9Xkvo",
  "tokenURI": "ipfs://QmX7UbPKJ7Drci3y6p6E8oi5TpUiG7NH3qSzcohPX9Xkvo",
  "nsfwDetection": null
}

[400] Generic Error

{
  "success": false,
  "error": "Error message"
}

[400] NSFW Image Uploaded

{
  "success": false,
  "error": "Content flagged: Suggestive content",
  "nsfwDetection": {
    "isNSFW": true,
    "score": 0.92,
    "message": "Content flagged: Suggestive content",
    "details": []
  }
}

Launch Token

POST /api/v1/{{ base | base-sepolia }}/launch-memecoin

Tokens can be launched on either base or base-sepolia based on the parameter passed in the API call.

Creates a new memecoin token on the selected network with the following default parameters:

• $10k starting market cap

• 60% of the total supply for fair launch

• 80% dev / 20% community split

• No revenue manager

After a token has been flaunched, a jobId will be returned in the response. This jobId signifies its position in a queue to be flaunched. It can then be referenced when querying the launch-status endpoint to retrieve the status of the token and subsequent deployed contract address of the token.

Required Fields

Name	Value
name	Token name.
symbol	Token symbol (max 8 characters).
description	Token description.
imageIpfs	IPFS hash from the image upload endpoint.

Creator Authentication Options (MUST choose one)

Name	Value
creatorAddress	Ethereum address to receive creator benefits.
creatorEmail	Email address to create a managed wallet via Privy.
creatorTwitterUsername	Twitter username for verification and wallet creation.
creatorFarcasterUsername	Farcaster username for verification and wallet creation.

If no creator authentication option is provided, the creator fees will go to the Flaunch.gg wallet.

Optional Fields

Name	Value
revenueManagerAddress	Ethereum address of a deployed revenue manager (must be valid address format)
marketCap	Initial market cap in USDC (default: 10,000 = 10000000000)
creatorFeeSplit	Creator fee allocation in basis points (default: 8000 = 80%)
fairLaunchDuration	Duration of fair launch in seconds (default: 1800 = 30 minutes)
fairLaunchSupply	Amount of tokens for fair launch (default: 60% of initial supply = 6000)
websiteUrl	Website URL
telegramUrl	Telegram group URL
discordUrl	Discord server URL
twitterUrl	Twitter/X URL

Rate Limits: Maximum 2 memecoin launches per minute per IP address

Headers

Name	Value
Content-Type	application/json

Body

{
  "name": "Example Coin",
  "symbol": "EXCOIN",
  "description": "This is an example memecoin for demonstration purposes.",
  "imageIpfs": "QmR4Tnqvm4SahFwez3FBCbweYwUPUXo2SP8yePhLXYQJkd",
  "websiteUrl": "https://example.com",
  "discordUrl": "https://discord.gg/example",
  "twitterUrl": "https://twitter.com/example",
  "telegramUrl": "https://t.me/example",
  "creatorAddress": "0x498E93Bc04955fCBAC04BCF1a3BA792f01Dbaa96",
  "marketCap": "10000000000",
  "creatorFeeSplit": "8000",
  "fairLaunchDuration": "1800"
}

Response

[200] Success Response

{
  "success": true,
  "message": "Memecoin launch request queued",
  "jobId": "40",
  
  // Queue status will show how long the expected flaunch time should be. The
  // `estimatedWaitSeconds` can offset the initial "Check Launch Status" delay.
  "queueStatus": {
    "position": 0,
    "waitingJobs": 0,
    "activeJobs": 1,
    "estimatedWaitSeconds": 0
  },
  
  // Privy data will vary depending on the `creatorType` specified
  "privy": {
    "type": "wallet",
    "address": "0x498E93Bc04955fCBAC04BCF1a3BA792f01Dbaa96"
  }
}

[400] Missing Data

{
  "success": false,
  "error": "Missing required fields: name, symbol, description, imageIpfs"
}

Check Launch Status

GET /api/v1/launch-status/{{ jobId }}

Retrierves the launch status of a jobId.

Headers

Name	Value
Content-Type	application/json

Response

[200] Job Complete

{
  "success": true,
  "state": "completed",
  "queuePosition": 0,
  "estimatedWaitTime": 0,
  "transactionHash": "0x04e594ee46312eecee8827aa2fef777dd2a94d247b723662be3a6daabb300028",
  "collectionToken": {
    "address": "0x06199b4b69f815141C197D034698d9E67Cdd265b",
    "imageIpfs": "QmQX8pdLRGeNps92Ma4esew7cbnYuBxQK7xUvp5soe3Lec",
    "name": "My Awesome Coin",
    "symbol": "MAC",
    "tokenURI": "ipfs://QmSxzzNaeHbYZbPyFF29Z1PrhrsfNNMyFvebZeuLPrkzvA",
    "creator": "0x4d7c5DFceC78E011E16BFe9F701D857841bbDFbB"
  }
}

[200] Job Pending

{
  "success": true,
  "state": "waiting",
  "queuePosition": 2,
  "estimatedWaitTime": 120
}

[200] Job Active

{
  "success": true,
  "state": "active",
  "queuePosition": 0,
  "estimatedWaitTime": 0
}

[400] Job Unknown

{
  "success": false,
  "error": "Job not found"
}