cURL

curl --request POST \
  --url https://api.openformat.tech/v1/reward/XP \
  --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
}
'

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

Rewards

Reward XP

deprecated

⚠️ DEPRECATED: This endpoint has been deprecated and replaced by the Reward Point endpoint. Please use the Reward Point endpoint for all new implementations.

Award XP (Experience Points) to users for completing specific actions in your application. This endpoint is designed to gamify user engagement by rewarding XP for various activities such as:

User registration
Task completion
Video watching
Comment posting
Other custom actions

The endpoint returns an unsigned transaction that needs to be signed using your application’s private key (stored securely in server environment variables). After signing, you can broadcast the transaction using either:

Execute Transaction endpoint for immediate submission
Execute Transaction and Wait endpoint if you need to wait for transaction confirmation

This XP system helps create an engaging progression system while maintaining transparency through blockchain-based XP distribution.

POST

reward

cURL

curl --request POST \
  --url https://api.openformat.tech/v1/reward/XP \
  --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
}
'

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

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

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

number

required

Amount of tokens to reward

Required range: x > 0

Example:

123

Response

Rewards XP

status

enum<string>

required

Success response status

Available options:

success

Example:

"success"

unsignedTransaction

any | null

Unsigned transaction object for the user to sign

Reward Badge Create Credit token

Documentation Index

Authorizations

Body

Response