Request Funds from Faucet

POST 
https://minatokens.com/api/v1//faucet

Requests funds from the faucet for testing purposes.

Request

application/json

Bodyrequired

addressstringrequired

The Mina address (public key) to receive the test tokens.

Responses

200

Faucet response

application/json

Schema

Schema

successboolean

Indicates whether the faucet request was successful.

hashstring

The transaction hash of the faucet transfer if successful.

errorstring

Error message if the request failed.

Example (auto)

{
  "success": true,
  "hash": "string",
  "error": "string"
}

400

Bad request - invalid input parameters.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

401

Unauthorized - user not authenticated.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

403

Forbidden - user doesn't have permission.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

429

Too many requests.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

500

Internal server error - something went wrong during the request.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

503

Service unavailable - blockchain or other external service is down.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

Authorization: x-api-key

name: x-api-keytype: apiKeyin: headerdescription: API key for authorization. Get your API key at https://minatokens.com/api

• curl
• javascript
• nodejs
• python
• rust
• ocaml
• go
• java
• powershell

• CURL

curl -L 'https://minatokens.com/api/v1/faucet' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-api-key: <x-api-key>' \
-d '{
  "address": "string"
}'

Request Collapse all

Base URL

https://minatokens.com/api/v1

Auth

ApiKeyAuth

Body required

{
  "address": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!