Onboarding
Get the onboarding facts.
Machine-readable onboarding for agents, no key needed: what works without a key (the MCP server, listAssets, listNetworks), how to get a key self-serve, the testnet sandbox, a first call and the pricing. Every claim carries URLs you can fetch anonymously to verify it, on the origin of the transport you called (onion over Tor).
get/onboarding
Request
- Base URL: https://chainflip-broker.io
- URL: https://chainflip-broker.io/onboarding
- Auth: none declared
Response
The onboarding facts.
Example response
{
"service": "Chainflip Broker as a Service",
"noKeyNeeded": {
"available": true,
"description": "The MCP server and the asset and network listings work without any key or account.",
"mcpServer": "https://chainflip-broker.io/mcp"
},
"apiKeys": {
"selfServe": true,
"requiredFor": "REST quotes, swaps, status, swap history and fees. Optional on the MCP tools.",
"signupUrl": "https://chainflip-broker.io/register",
"signup": "One free web form, no payment details: a name, an optional email, your commission and an Ethereum address for payouts. The key is shown at once.",
"description": "The API key identifies your partner account and is safe to share. Only the dashboard admin key is a secret."
},
"sandbox": {
"name": "Testing environment, connected to the Chainflip Perseverance testnet",
"description": "Same API, same paths and parameters, swapping testnet assets with no real value. Register there separately for a testnet API key.",
"apiBaseUrl": "https://perseverance.chainflip-broker.io/",
"documentation": "https://docs.chainflip-broker.io/environments/testing/"
},
"firstCall": {
"method": "GET",
"url": "https://chainflip-broker.io/assets",
"authentication": "none",
"curl": "curl -s https://chainflip-broker.io/assets"
},
"openApi": "https://chainflip-broker.io/docs/v1/docs.json",
"llmsTxt": "https://chainflip-broker.io/llms.txt",
"documentation": "https://docs.chainflip-broker.io/getting-started/",
"pricing": {
"description": "No subscription: a 0.05% (5 bps) operating fee is added to each swap, and you set your own broker fee on top.",
"documentation": "https://docs.chainflip-broker.io/resources/pricing/"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.