API docs by Redocly

Doginals Bot (1.0.0)

Download OpenAPI specification:Download

License: Apache-2.0

Doginals Bot is no joke! We let you mint NFTs (Doginals) on Dogecoin's blockchain in a cost and time efficient way.

api

Doginals Bot Public Endpoints

Calculate Cost

Estimate the cost (in koinu) of an order before you place it.

Authorizations:
ApiAuthKey
Request Body schema: application/json
required

Array of base64 uploads in the data URI scheme, similar to submitting an order

required
Array of objects (requestUpload)
fee
integer

koinu per byte (default 250,000)

additionalFee
integer

additional koinu per file that goes to the referral address

optimized
boolean

compress image to cut cost of inscription

Responses

Request samples

Content type
application/json
{
  • "uploads": [
    ],
  • "fee": 5000,
  • "additionalFee": 100000,
  • "optimized": true
}

Response samples

Content type
{
  "amount": 459701000,
  "serviceFee": 243446000,
  "networkFee": 204755000,
  "additionalFee": 11400000,
  "postage": 100000
}

Mint Your Art

Submit your art to be minted on Doge once you pay the returned address.

Authorizations:
ApiAuthKey
Request Body schema: application/json
required

Array of base64 uploads in the data URI scheme

required
Array of objects (requestUpload)
receiveAddress
required
string

destination address for the doginal being minted

fee
integer

cost in koinu per byte (default 250,000)

additionalFee
integer

amount in koinu (minimum 100,000) that goes to referral address (if included, referral is also required)

referral
string

name of the referral (requires specifying additionalFee if included)

optimized
boolean

compress image to cut cost of inscription

webhookUrl
string

The endpoint that Doginals Bot will post to with the following data (contained in the body) at each stage:

  • Payment in mempool
    {
  "id": "sampleId",
  "state": "waiting-confirmation"
}

* Payment confirmed

{ "id": "sampleId", "state": "paid" }

* Upload queued for processing

{
  "id": "sampleId",
  "state": "queued",
  "file": {
    "id": "fileId",
    "name": "foo.jpg",
    "publicLink": "https://test-image-bucket-1.s3.amazonaws.com/.../foo.jpg",
    "size": 29678
  }
}

* Upload inscribed

{
  "id": "sampleId",
  "state": "inscribed",
  "file": {
    "id": "fileId",
    "name": "foo.jpg",
    "inscription": "0123456789abcdef00i0",
    "publicLink": "https://test-image-bucket-1.s3.amazonaws.com/.../foo.jpg",
    "size": 29678
  }
}

Responses

Request samples

Content type
application/json
{
  • "uploads": [
    ],
  • "receiveAddress": "DNzUG8RuBi1twqv8QGjpFAZDhx5gWmDyXd",
  • "fee": 5000,
  • "referral": "awesome",
  • "additionalFee": 100000,
  • "webhookUrl": "http://www.myawesomesite.com",
  • "optimized": true
}

Response samples

Content type
{
  "orderId": "clv2n7hff0000743rh82x9ag2",
  "payment": {
    "address": "DLjmsyXMDJs6p8GoLeGgFtvv8YC4bZDnB7",
    "amount": 459701000,
    "serviceFee": 243446000,
    "networkFee": 204755000,
    "additionalFee": 11400000,
    "postage": 100000
  },
  "receiveAddress": "DNzUG8RuBi1twqv8QGjpFAZDhx5gWmDyXd",
  "fee": 5000,
  "referral": "awesome",
  "additionalFee": 100000,
  "timeSubmitted": "2024-05-23T16:58:54.912Z",
  "webhookUrl": "http://www.myawesomesite.com",
  "uploads": [
    {
      "name": "upload1.jpg",
      "size": 29678,
      "publicLink": "https://test-image-bucket-1.s3.amazonaws.com/clwb1lmi40000b63ra9xc9hqv/clwb1lmi40001b63r7ya58ra1/foo.jpg",
      "payment": {
        "address": "DLjmsyXMDJs6p8GoLeGgFtvv8YC4bZDnB7",
        "amount": 448401000,
        "serviceFee": 243446000,
        "networkFee": 204755000,
        "additionalFee": 100000,
        "postage": 100000,
        "paid": true
      }
    }
  ]
}

Check Order Status

Check the mint status and inscription id transaction of your order.

Authorizations:
ApiAuthKey
query Parameters
id
string
Example: id=clv2n7hff0000743rh82x9ag2

id of the order being retrieved

Responses

Response samples

Content type
Example
{
  "id": "clv2n7hff0000743rh82x9ag2",
  "payment": {
    "address": "DLjmsyXMDJs6p8GoLeGgFtvv8YC4bZDnB7",
    "amount": 459701000,
    "serviceFee": 243446000,
    "networkFee": 204755000,
    "additionalFee": 11400000,
    "postage": 100000
  },
  "receiveAddress": "DNzUG8RuBi1twqv8QGjpFAZDhx5gWmDyXd",
  "fee": 5000,
  "referral": "awesome",
  "additionalFee": 100000,
  "status": "COMPLETE",
  "timeSubmitted": "2024-05-23T16:58:54.912Z",
  "webhookUrl": "http://www.myawesomesite.com",
  "uploads": [
    {
      "name": "upload1.jpg",
      "size": 29678,
      "publicLink": "https://test-image-bucket-1.s3.amazonaws.com/clwb1lmi40000b63ra9xc9hqv/clwb1lmi40001b63r7ya58ra1/foo.jpg",
      "status": "COMPLETE",
      "inscriptionId": "e7ca0ae5d8e585b653f7753b5a8e3e7a0c6aaaa55985b305a50cbe71a555594d",
      "payment": {
        "address": "DLjmsyXMDJs6p8GoLeGgFtvv8YC4bZDnB7",
        "amount": 448401000,
        "serviceFee": 243446000,
        "networkFee": 204755000,
        "additionalFee": 100000,
        "postage": 100000,
        "paid": true
      }
    }
  ]
}

Create a new referral

Authorizations:
ApiAuthKey
query Parameters
name
required
string
Example: name=awesome

Referral code

address
required
string
Example: address=awesome

Wallet that will receive additional fee for mints that use this referral

Responses

Response samples

Content type
{
  "name": "awesome",
  "address": "DLjmsyXMDJs6p8GoLeGgFtvv8YC4bZDnB7"
}