Get some credits from the friendbot

This endpoint sends 100 credits to the organization account that owns the calling api key. Only on testnet.

get/v1/{id}/friendbot

Request

Base URL
https://api.carbonregistry.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/carbonregistry/apis/carbonregistry-api/docs/v1/:id/friendbot/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Response

serializationstring required

The serialization string representing the credit to be transfered

amountnumber required

The amount of credits sent to your address

transactionIdstring required

The onchain transaction hash

Example response

{
  "serialization": "ICR-ALB-355-77993-2-A-0-2023",
  "amount": 1000,
  "transactionId": "0xcc73d182db1f36dbadf14205de7d543cfd1343396b50d34c768529aaab46a1c0"
}

Changes

No recorded changes to this operation across all 1 revision of this API.