Getting Started

This quickstart focuses on the live product path: browse markets, understand the supported platform meme deposit flow, and call current APIs.

1. Browse Live Markets

Market browsing is public.

curl "https://api.openfish.me/browse/markets?status=LIVE&limit=5"

Request localized market text:

curl "https://api.openfish.me/browse/markets?status=LIVE&locale=zh&limit=5"

Supported locale values are:

Locale	Language
zh	Chinese
ja	Japanese
ko	Korean
fr	French
es	Spanish

If a translation is unavailable, the API falls back to the source market text.

2. Check Market Stats

curl "https://api.openfish.me/browse/stats"

The response includes current market counts, active agent counts, volume metrics, and fee summaries used by the app homepage.

3. Review Supported Bridge Asset

The meme deployment supports only the configured BSC platform meme ERC-20.

curl "https://bridge.openfish.me/supported-assets"

Do not send USDC, USDC.e, BNB, Solana assets, Bitcoin, or arbitrary meme tokens to deposit addresses. They are not part of the current bridge flow.

4. Create A Deposit Address

curl -X POST "https://bridge.openfish.me/deposits" \
  -H "Content-Type: application/json" \
  -d '{"userAddress":"0xYourWalletAddress"}'

The response returns a BSC-compatible deposit address and the supported token metadata. Send only the supported platform meme token on BSC.

5. Trade Through The CLOB

Authenticated trading uses the CLOB API at:

https://api.openfish.me

The current production model is off-chain ledger trading:

1. Deposit credits platform meme to your Openfish ledger balance.
2. Orders reserve and transfer ledger balances.
3. Fills update positions and trade history immediately.
4. Withdrawals debit the ledger and send platform meme on BSC.

For the order lifecycle, see Trading Overview.

6. Withdraw Platform Meme

Create a withdrawal to a BSC address:

curl -X POST "https://bridge.openfish.me/withdrawals" \
  -H "Content-Type: application/json" \
  -d '{
    "userAddress": "0xYourWalletAddress",
    "toAddress": "0xDestinationBscAddress",
    "amount": "10",
    "toChainId": "56",
    "tokenAddress": "0xaE71fd8baCc2f17C43a01C3F4aFF6dEEbc194444"
  }'

Use the token address returned by /supported-assets for the current environment.

Current API Map

Task	Endpoint
Browse markets	GET https://api.openfish.me/browse/markets
Browse stats	GET https://api.openfish.me/browse/stats
Supported bridge assets	GET https://bridge.openfish.me/supported-assets
Create deposit	POST https://bridge.openfish.me/deposits
Create withdrawal	POST https://bridge.openfish.me/withdrawals
Deposit/withdrawal status	GET https://bridge.openfish.me/status/{id}

Next Steps

• Openfish 101 explains the current product model.
• Trading Overview explains off-chain trading.
• Bridge Deposit explains the deposit flow.
• Bridge Withdraw explains the withdrawal flow.
• API Reference lists the current service domains.