CYCLOPS LABSDOCS / PRE-LAUNCH APIFILE Nº D6

Check creators
before launch.

For launchpads. Run the same pre-launch check a creator can run on /check, from your own launch flow, and show them what a scan will read before their token goes live.

REQUEST

One
call.

SHELL
curl -X POST https://cyclopslabs.dev/api/v1/partner/prelaunch \
  -H 'x-api-key: $CYCLOPS_API_KEY' -H 'content-type: application/json' \
  -d '{"creator": "0x…", "name": "…", "symbol": "…", "taxBps": 300}'
TYPESCRIPT · fetch
const res = await fetch('https://cyclopslabs.dev/api/v1/partner/prelaunch', {
  method: 'POST',
  headers: { 'x-api-key': process.env.CYCLOPS_API_KEY!, 'content-type': 'application/json' },
  body: JSON.stringify({ creator, name, symbol, taxBps }),
});
if (res.status === 429) { /* Retry-After header: seconds to wait */ }
const check = await res.json(); // { id, observations, counts, badge, page, wording, … }

Authentication: an API key owned by a verified wallet, sent as x-api-key. Any tier works. Anonymous keys are not accepted here; a request without a wallet-owned key answers 401 api_key_required. Create a key on the account page or with one signature (see keys for agents).

Limits: up to 120 checks an hour per key, on top of the key’s own hourly limit. Over the limit answers 429 with Retry-After. A check reads the chain with a 4-second budget; anything it could not read lands in partial.

Errors: 400 with { error, message } for bad input, 502 check_failed if the check could not finish.

FIELDS

In and
out.

REQUEST BODY · JSON
creatorRequired. The wallet that will create the token (0x…, 40 hex).
nameOptional. Token name, matched against indexed launches with look-alike characters folded.
symbolOptional. Ticker without the $.
taxBpsOptional. Buy tax in basis points, an integer from 0 to 10000 (500 = 5%).
contractOptional. A token contract that is already deployed; its code is read for owner powers.
RESPONSE · JSON
id12 hex characters; the record lives at /check/<id> and GET /v1/prelaunch/<id>.
observations[]{ key, severity: flag | watch | info, text, refs? }. refs are addresses or transaction hashes.
counts{ flag, watch, info }.
badge{ svg, text }. svg is an absolute URL to the record’s badge.
receiptAbsolute URL to the stored record.
pageAbsolute URL of the public record page to show your creator.
partial[]Parts that could not be read in time. Nothing is assumed for them.
wordingThe sentence to show next to the result.
WORDING

How to
show it.

  • Say “scanned”. Show the result as “Scanned by Cyclops” or “Pre-launch check”. Never call a creator or token safe, verified, audited, approved or trusted because of it.
  • Show the flags, not a grade. The check has no pass or fail. List the observations, or link the page so the creator can read them all.
  • Keep the badge linked. If you show the badge, link it to page so anyone can see what was read.
  • Say what it covers. It reads the inputs before launch. It says nothing about holders, trades or what happens after launch; scans of the live token do that.
  • Show wording next to the result, or a sentence that says the same.

Every check is stored as a public record. Do not send names or tickers you need to keep private.