> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inkyswap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> Choose the right InkyPump surface for launch creation, indexed data, or InkySwap quotes.

InkyPump exposes on-chain contracts and a server-side read API. They serve different jobs.

## Which surface to use

| You want to | Use |
| - | - |
| Create a token with the user's wallet | Active hook from `GET /api/capabilities` |
| Create an xStocks-quoted token | Per-asset hook from `GET /api/xstocks/quote-assets` |
| Prove a launch succeeded | Transaction receipt and `LaunchCreated` event |
| Discover indexed tokens and metrics | InkyPump read API at `https://inkypump.com` |
| Route an existing token | Its indexed `hook_address` and `launch_id` |
| Read wider InkySwap pairs or quotes | InkySwap API at `https://inkyswap.com` |

Start with the [Launchpad Quickstart](/integrations/launchpad-quickstart) if you are adding InkyPump to another launchpad.

## Production networks

| Network | Chain ID | New native launches |
| - | -: | - |
| Ink | `57073` | Discover through `/api/capabilities?chainId=57073` |
| Robinhood | `4663` | Discover through `/api/capabilities?chainId=4663` |

Deployment addresses can change. Existing tokens remain on their original hook. Do not use one global hardcoded hook for both new and historical tokens.

## InkyPump read API

Core server-side routes:

| Endpoint | Purpose |
| - | - |
| `GET /api/capabilities?chainId=` | Active and historical deployment registry |
| `GET /api/health/ready` | Service readiness and release |
| `GET /api/token?chainId=&address=` | One token's indexed identity, lifecycle, and metrics |
| `GET /api/tokens/recent-v2?chainId=&limit=&offset=` | Recent V2 launches |
| `GET /api/tokens?chainId=&page=&sortBy=` | Filtered discovery list |
| `GET /api/tokens/by-owner?chainId=&owner=` | All indexed tokens from a creator |
| `GET /api/tokens/batch?chainId=&addresses=a,b` | Up to 50 addresses in one request |
| `GET /api/xstocks/quote-assets?chainId=57073` | Supported xStocks wrappers and hooks |
| `GET /api/referral/:address?chainId=` | Points and referral-code record |
| `GET /api/referrals/:chain/dashboard/:address` | Fee-earning referral accounting |

Read [API Policies](/api-reference/policies) before building. Always pass `chainId`, keep exact decimal strings, and call the API from your backend.

## Contract writes

Use a browser wallet or another user-controlled signer. The caller becomes the launch creator and fee recipient.

For native launches:

```solidity theme={null}
createLaunch(CreateLaunchParams params) payable returns (uint256 launchId)
```

For xStocks launches:

```solidity theme={null}
createLaunchWithQuotePrebuy(CreateLaunchParams params, uint256 quotePrebuy)
    returns (uint256 launchId)
```

Simulate the exact call, save the transaction hash, verify the receipt event, then wait for indexed discovery. API indexing is not part of transaction success.

## InkySwap API

The InkySwap API covers the wider DEX on Ink:

| Endpoint | Purpose |
| - | - |
| `GET /api/pairs` | Liquidity pairs |
| `GET /api/quote` | Swap quote and optional transaction plan |
| `GET /api/tokens` | Listed DEX tokens |

These routes are separate from InkyPump's curve and market-routing services.

## MCP status

`@inkyswap/pump-mcp` is an operator tool that signs with a configured hot wallet. Its published `0.1.1` release still pins the older Ink hook and is not the recommended path for a new launchpad integration. Use the wallet quickstart and runtime deployment discovery instead.

## Version and proof

The partner docs were checked against production and source on September 21, 2026. Runtime responses remain authoritative for feature flags and deployment identities.

<CardGroup cols={2}>
  <Card title="Launchpad Quickstart" icon="rocket" href="/integrations/launchpad-quickstart">
    A receipt-safe, browser-wallet launch flow.
  </Card>

  <Card title="API Policies" icon="shield" href="/api-reference/policies">
    Chain, CORS, precision, error, and retry rules.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.