My App

Faucet

Faucet.

POST
/faucet
OBSIDIAN-KEY<token>

In: header

OBSIDIAN-SECRET<token>

In: header

user_address?string
asset?string

The asset to be sent. (e.g., ETH, USDC). It also can be the address of the token contract (0xabc...).

amount?string

The amount to be sent in decimal format, 0.1 means 0.1BTC, not in wei format).

on_chain?boolean

If true, the faucet will attempt to send the asset on-chain. Else, it just silently adds the asset to the user's account balance.

Response Body

application/json

application/json

curl -X POST "https://api.dev.obsidian.exchange/faucet" \  -H "Content-Type: application/json" \  -d '{}'
{
  "user_address": "string",
  "token_address": "string",
  "amount": "string",
  "tx_hash": "string"
}
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string",
      "property1": null,
      "property2": null
    }
  ]
}