Token API Reference

• Upload
  • postUpload a file to Bitcoin
• Download
  • getDownload file by File ID
  • getDownload file by Transaction ID
• Status
  • getGet transaction status by File ID
  • getGet transaction status by Transaction ID

API docs by Redocly

Pigi (1.0)

Download OpenAPI specification:Download

mintBlue Support: support@mintBlue.com URL: http://www.mintBlue.com

Pigi API Specification

Upload

Upload a file to Bitcoin

Upload file.

If no pigi-* headers are supplied, no additional verification is done. When they are supplied the server validates whether they match the uploaded file.

Use response.identifiers.transaction[0] if it is present, otherwise use response.identifiers.file[0]

Authorizations:

API Access Token

header Parameters

pigi-file-id-hex	string SHA256 of the uploaded file encoded in hex
pigi-file-secret-hex	string First 32 bytes of the SHA512 of the uploaded file encoded in hex

Request Body schema: multipart/form-data

file	string <binary>

Responses

https://api.mintblue.com/api/v1/pigi/upload

https://test.api.next.kyrt.net/api/v1/pigi/upload

http://localhost:8777/api/v1/pigi/upload

Request samples

• Payload

Content type

multipart/form-data

No sample

Response samples

• 200

Content type

application/json

Example

example-upload-success-with-transaction-createdexample-upload-success-with-failed-transactionexample-upload-success-with-transaction-created

{

• "pigi": {

  • "version": 0,
  • "algorithm": "aes-256-cbc:lzma:cbor",
  • "encryptedSize": 112,
  • "_algorithmIndex": 0,
  • "_idHex": "293ed9bd615ab11de703d27de3843c578c04d74c9f3549a00b924e9128036f1c"

  },
• "bitcoin": {

  • "fee": 188,
  • "size": 376,
  • "txid": "48b587c14b2b82c597ac96a910151a99001c999d1f24625170b19e1d22cfc63b",
  • "rawtx": "0100000001d2728b2c4255714f740a21f0f60923789fff83caeaecf21879d399163778f185010000006b483045022100a683fa08130489e10ec8bff67b95cf1e755e6879887d24e9411d046a99b4e7ea02205e1bc1c1cae4fb665a7468840440339e6e3235bb5687ab7359bd5b4f16580fdc41210391cb19127cd26e8b419bc15faae19ed3e95a69f38f67560b933f0bb6f10d25f8ffffffff020000000000000000af006a04746573744ca60000293ed9bd615ab11de703d27de3843c578c04d74c9f3549a00b924e9128036f1c0000007013250da79444e87a82af9b82282dea8ba2716cbdd882f86867e9762784d30a8fda1c75932cd5cf6ca5422ee2b7e2f06749efa8f8564961e7e8e2347aeee8d044ee84257fb9135a505c5f78b708ed92e485f220bcf5c57c4b93888f5bd9d1c6e26a45e58972aec18b550ec385f022d11268978866a71d5b3309d4c3dd1a953bdf3f0f0300000000001976a914ae99d5c0320dcdd9971491c8ff20dc6c65f2f50e88ac00000000",
  • "explore": {

    • "whatsonchain": "https://www.whatsonchain.com/tx/48b587c14b2b82c597ac96a910151a99001c999d1f24625170b19e1d22cfc63b",
    • "blockchair": "https://blockchair.com/bitcoin-sv/transaction/48b587c14b2b82c597ac96a910151a99001c999d1f24625170b19e1d22cfc63b"

    }

  },
• "identifiers": {

  • "raw": {

    • "fileid": "293ed9bd615ab11de703d27de3843c578c04d74c9f3549a00b924e9128036f1c1",
    • "secret": "Q4imbEDsOUF1FqzQVdywOGKkBzdICfysNPhTXzPKyLIE",
    • "txid": "48b587c14b2b82c597ac96a910151a99001c999d1f24625170b19e1d22cfc63b"

    },
  • "file": [

    • "https://test.api.next.kyrt.net/api/v1/pigi/f/293ed9bd615ab11de703d27de3843c578c04d74c9f3549a00b924e9128036f1c?s=Q4imbEDsOUF1FqzQVdywOGKkBzdICfysNPhTXzPKyLIE",
    • "pigi://pigi.kyrt.net/f/293ed9bd615ab11de703d27de3843c578c04d74c9f3549a00b924e9128036f1c?s=Q4imbEDsOUF1FqzQVdywOGKkBzdICfysNPhTXzPKyLIE",
    • "http://localhost:8777/api/v1/pigi/f/293ed9bd615ab11de703d27de3843c578c04d74c9f3549a00b924e9128036f1c?s=Q4imbEDsOUF1FqzQVdywOGKkBzdICfysNPhTXzPKyLIE"

    ],
  • "transaction": [

    • "https://test.api.next.kyrt.net/api/v1/pigi/t/48b587c14b2b82c597ac96a910151a99001c999d1f24625170b19e1d22cfc63b?s=Q4imbEDsOUF1FqzQVdywOGKkBzdICfysNPhTXzPKyLIE",
    • "pigi://pigi.kyrt.net/t/48b587c14b2b82c597ac96a910151a99001c999d1f24625170b19e1d22cfc63b?s=Q4imbEDsOUF1FqzQVdywOGKkBzdICfysNPhTXzPKyLIE",
    • "http://localhost:8777/api/v1/pigi/t/48b587c14b2b82c597ac96a910151a99001c999d1f24625170b19e1d22cfc63b?s=Q4imbEDsOUF1FqzQVdywOGKkBzdICfysNPhTXzPKyLIE"

    ]

  },
• "info": {

  • "file": [

    • "https://test.api.next.kyrt.net/api/v1/pigi/fi/293ed9bd615ab11de703d27de3843c578c04d74c9f3549a00b924e9128036f1c",
    • "pigi://pigi.kyrt.net/fi/293ed9bd615ab11de703d27de3843c578c04d74c9f3549a00b924e9128036f1c",
    • "http://localhost:8777/api/v1/pigi/fi/293ed9bd615ab11de703d27de3843c578c04d74c9f3549a00b924e9128036f1c"

    ],
  • "transaction": [

    • "https://test.api.next.kyrt.net/api/v1/pigi/ti/48b587c14b2b82c597ac96a910151a99001c999d1f24625170b19e1d22cfc63b",
    • "pigi://pigi.kyrt.net/ti/48b587c14b2b82c597ac96a910151a99001c999d1f24625170b19e1d22cfc63b",
    • "http://localhost:8777/api/v1/pigi/ti/48b587c14b2b82c597ac96a910151a99001c999d1f24625170b19e1d22cfc63b"

    ]

  }

}

Download

Download file by File ID

The content type header will be set to the mimetype of the file

path Parameters

fileId required

string File ID encoded in hex

query Parameters

s	string Secret encoded in base62

Responses

https://api.mintblue.com/api/v1/pigi/f/{fileId}

https://test.api.next.kyrt.net/api/v1/pigi/f/{fileId}

http://localhost:8777/api/v1/pigi/f/{fileId}

Download file by Transaction ID

The content type header will be set to the mimetype of the file

path Parameters

txId required

string Transaction ID encoded in hex

query Parameters

s	string Secret encoded in base62

Responses

https://api.mintblue.com/api/v1/pigi/t/{txId}

https://test.api.next.kyrt.net/api/v1/pigi/t/{txId}

http://localhost:8777/api/v1/pigi/t/{txId}

Status

Get transaction status by File ID

Transaction status contains information about the transaction

path Parameters

fileId required

string

Responses

https://api.mintblue.com/api/v1/pigi/fi/{fileId}

https://test.api.next.kyrt.net/api/v1/pigi/fi/{fileId}

http://localhost:8777/api/v1/pigi/fi/{fileId}

Response samples

• 200

Content type

application/json

null

Get transaction status by Transaction ID

Transaction status contains information about the transaction

path Parameters

txId required

string

Responses

https://api.mintblue.com/api/v1/pigi/ti/{txId}

https://test.api.next.kyrt.net/api/v1/pigi/ti/{txId}

http://localhost:8777/api/v1/pigi/ti/{txId}

Response samples

• 200

Content type

application/json

null