Skip to main content
POST
/
reward
/
badge
cURL
curl --request POST \
  --url https://api.openformat.tech/v1/reward/badge \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "chain": "arbitrum-sepolia",
  "action_id": "dragon_slayed",
  "receiver": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
  "app_id": "0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a",
  "amount": 123,
  "badge_name": "Valiant warrior",
  "base_uri": "ipfs://abc...",
  "badge_id": "0xd1f09c70f6f2838a3ab6209c1465af68594667ec"
}
'
import requests

url = "https://api.openformat.tech/v1/reward/badge"

payload = {
    "chain": "arbitrum-sepolia",
    "action_id": "dragon_slayed",
    "receiver": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
    "app_id": "0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a",
    "amount": 123,
    "badge_name": "Valiant warrior",
    "base_uri": "ipfs://abc...",
    "badge_id": "0xd1f09c70f6f2838a3ab6209c1465af68594667ec"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    chain: 'arbitrum-sepolia',
    action_id: 'dragon_slayed',
    receiver: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    app_id: '0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a',
    amount: 123,
    badge_name: 'Valiant warrior',
    base_uri: 'ipfs://abc...',
    badge_id: '0xd1f09c70f6f2838a3ab6209c1465af68594667ec'
  })
};

fetch('https://api.openformat.tech/v1/reward/badge', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openformat.tech/v1/reward/badge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'chain' => 'arbitrum-sepolia',
    'action_id' => 'dragon_slayed',
    'receiver' => '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    'app_id' => '0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a',
    'amount' => 123,
    'badge_name' => 'Valiant warrior',
    'base_uri' => 'ipfs://abc...',
    'badge_id' => '0xd1f09c70f6f2838a3ab6209c1465af68594667ec'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.openformat.tech/v1/reward/badge"

	payload := strings.NewReader("{\n  \"chain\": \"arbitrum-sepolia\",\n  \"action_id\": \"dragon_slayed\",\n  \"receiver\": \"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266\",\n  \"app_id\": \"0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a\",\n  \"amount\": 123,\n  \"badge_name\": \"Valiant warrior\",\n  \"base_uri\": \"ipfs://abc...\",\n  \"badge_id\": \"0xd1f09c70f6f2838a3ab6209c1465af68594667ec\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.openformat.tech/v1/reward/badge")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chain\": \"arbitrum-sepolia\",\n  \"action_id\": \"dragon_slayed\",\n  \"receiver\": \"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266\",\n  \"app_id\": \"0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a\",\n  \"amount\": 123,\n  \"badge_name\": \"Valiant warrior\",\n  \"base_uri\": \"ipfs://abc...\",\n  \"badge_id\": \"0xd1f09c70f6f2838a3ab6209c1465af68594667ec\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.openformat.tech/v1/reward/badge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"chain\": \"arbitrum-sepolia\",\n  \"action_id\": \"dragon_slayed\",\n  \"receiver\": \"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266\",\n  \"app_id\": \"0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a\",\n  \"amount\": 123,\n  \"badge_name\": \"Valiant warrior\",\n  \"base_uri\": \"ipfs://abc...\",\n  \"badge_id\": \"0xd1f09c70f6f2838a3ab6209c1465af68594667ec\"\n}"

response = http.request(request)
puts response.read_body
{
    "status": "success",
    "unsignedTransaction": {
        "to": "0x014b680bed2433b1861239cf812dbe660fe339f2",
        "data": "0x609512c90000000000000000000000009574e9ba92cb0966c9d2ff1a9ab9e11949b9b873000000000000000000000000f39fd6e51aad88f6f4ce6ab8827279cfffb922660000000000000000000000000000000000000000000000000de0b6b3a7640000647261676f6e5f736c6179656400000000000000000000000000000000000000414354494f4e000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000000",
        "maxPriorityFeePerGas": "30000000000",
        "maxFeePerGas": "30000000015",
        "gasLimit": "95935",
        "nonce": 2484,
        "chainId": 80001,
        "type": 2
    }
}

{
  "status": "failed",
  "error": "Too many badges for that name",
  "badges": [
    {
      "id": "0xda4074b4b844e035a59a881db4a9f43cf66c88be",
      "name": "Level 3"
    },
    {
      "id": "0xa414cf3e0faa0c0a828cadc3f70ca847ecdac088",
      "name": "Level 2"
    },
    {
      "id": "0x5b45310aec022a8b83c2b302a59369d8626ef5ec",
      "name": "Level 1"
    }
  ]
}


{
  "status": "failed",
  "error": "No badge found"
}

{
    "status": "success",
    "unsignedTransaction": {
        "to": "0x014b680bed2433b1861239cf812dbe660fe339f2",
        "data": "0x609512c90000000000000000000000009574e9ba92cb0966c9d2ff1a9ab9e11949b9b873000000000000000000000000f39fd6e51aad88f6f4ce6ab8827279cfffb922660000000000000000000000000000000000000000000000000de0b6b3a7640000647261676f6e5f736c6179656400000000000000000000000000000000000000414354494f4e000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000000",
        "maxPriorityFeePerGas": "30000000000",
        "maxFeePerGas": "30000000015",
        "gasLimit": "95935",
        "nonce": 2484,
        "chainId": 80001,
        "type": 2
    }
}

{
  "status": "failed",
  "error": "Too many badges for that name",
  "badges": [
    {
      "id": "0xda4074b4b844e035a59a881db4a9f43cf66c88be",
      "name": "Level 3"
    },
    {
      "id": "0xa414cf3e0faa0c0a828cadc3f70ca847ecdac088",
      "name": "Level 2"
    },
    {
      "id": "0x5b45310aec022a8b83c2b302a59369d8626ef5ec",
      "name": "Level 1"
    }
  ]
}


{
  "status": "failed",
  "error": "No badge found"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
chain
string
required

Blockchain network to use

Required string length: 1 - 255
Example:

"arbitrum-sepolia"

​
action_id
string
required

Action Id

Required string length: 1 - 32
Example:

"dragon_slayed"

​
receiver
string
required

Ethereum addres of the receiver

Pattern: ^(0x)?[0-9a-fA-F]{40}$
Example:

"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266"

​
app_id
string
required

Ethereum address of the application

Pattern: ^(0x)?[0-9a-fA-F]{40}$
Example:

"0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a"

​
amount
integer
required

Amount of badges to reward

Required range: x >= 1
Example:

123

​
badge_name
string

Name of badge to reward, specify this or the badge_id

Required string length: 1 - 256
Example:

"Valiant warrior"

​
base_uri
string

URI of badge to reward

Maximum string length: 512
Example:

"ipfs://abc..."

​
badge_id
string

Ethereum address of badge to reward, specify this or badge name

Pattern: ^(0x)?[0-9a-fA-F]{40}$
Example:

"0xd1f09c70f6f2838a3ab6209c1465af68594667ec"

Response

Rewards Badge

​
status
enum<string>
required

Success response status

Available options:
success
Example:

"success"

​
unsignedTransaction
any | null

Unsigned transaction object for the user to sign