Setup

Get Started

OPENFORMAT

Integrate rewards and reputation into your community in minutes.

Welcome

In this page you will learn how to work with the the OPENFORMAT API

API Overview

API Reference

Generate an API Key Challenge for an account. Once you've generate your challenge, you need to [verify](/api-reference/endpoint/api-key/post-keyverify) it.

Challenge

Verify your signed challenge. You can sign your challenge using Metamask and our [signing tool](https://openformat-tools.vercel.app/).

Challenge verification

Reward users with points for completing specific actions in your application. This endpoint is designed to incentivise user engagement by awarding points for various activities such as:

- User registration
- Task completion
- Video watching
- Comment posting
- Other custom actions

The endpoint returns an [unsigned transaction](/api-reference/architecture/transaction-lifecycle) 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](/api-reference/endpoint/transactions/post-transactionsexecute) endpoint for immediate submission
- [Execute Transaction and Wait](/api-reference/endpoint/transactions/post-transactionsexecuteandwait) endpoint if you need to wait for transaction confirmation

This reward system helps build user engagement and loyalty while maintaining transparency through blockchain-based point distribution.


Mint Point/ERC-20

Transfer ERC-20 tokens to users in your application. This endpoint (previously known as "Credit") enables you to reward users with ERC-20 tokens for their actions or achievements. The endpoint returns an [unsigned transaction](/api-reference/architecture/transaction-lifecycle) 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](/api-reference/endpoint/transactions/post-transactionsexecute) endpoint for immediate submission
- [Execute Transaction and Wait](/api-reference/endpoint/transactions/post-transactionsexecuteandwait) endpoint if you need to wait for transaction confirmation

**Important Notes:**

1. **Default Behavior**: By default, this endpoint transfers existing ERC-20 tokens from the transaction sender's account to the receiver's account through the Application contract specified in the `app_id` parameter.

2. **Required Setup**: Before using this endpoint, you must create an allowance for the Application contract to transfer the required amount of tokens. This can be done using the [approve endpoint](/api-reference/endpoint/credit/post-creditapprove).

3. **Minting Option**: If you want to mint new tokens instead of transferring existing ones, set the optional parameter `mint` to `true`.


Transfer ERC-20

Reward Badge

⚠️ **DEPRECATED**: This endpoint has been deprecated and replaced by the [Reward Point](/api-reference/endpoint/triggers/post-rewardpoint) 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](/api-reference/architecture/transaction-lifecycle) 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](/api-reference/endpoint/transactions/post-transactionsexecute) endpoint for immediate submission
- [Execute Transaction and Wait](/api-reference/endpoint/transactions/post-transactionsexecuteandwait) 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.


Reward XP

This is endpoint returns an [unsigned transaction](/api-reference/architecture/transaction-lifecycle) that creates a new Credit token from the specified app. Once you sign this transaction, using your private key held in your local environment variables, you can broadcast it using the [Execute Transaction](/api-reference/endpoint/transactions/post-transactionsexecute) endpoint; or if you prefer to wait for confirmation using the [Execute Transaction and Wait](/api-reference/endpoint/transactions/post-transactionsexecuteandwait) endpoint.

Create Credit token

Show the Credit token balance of an account.

The returned response consists of 3 numbers:

- `balance` The absolute amount of tokens the user has.

- `decimals` The number of decimals defined in the Credit token.

- `balance_formatted` The user balance formatted to the token decimals. Example: for an balance of `1000000000000000000` with `18` decimals `balance_formatted` would be `1`. All token amount parameters in this API use this formatted mechanism.


Credit Balance

This is endpoint returns an [unsigned transaction](/api-reference/architecture/transaction-lifecycle) that pre-approves a `spender_address` account to transfer a specified amount of tokens from the `holder_address` account. Once you sign this transaction, using your private key held in your local environment variables, you can broadcast it using the [Execute Transaction](/api-reference/endpoint/transactions/post-transactionsexecute) endpoint; or if you prefer to wait for confirmation using the [Execute Transaction and Wait](/api-reference/endpoint/transactions/post-transactionsexecuteandwait) endpoint.

Create an allowance

This endpoint returns the necessary data for a Credit token holder to create a permit signature. This permit is used to allow a third party to transfer tokens on behalf of the token holder. Once this permit is signed it is sent to the [Transfer Credit Token](/api-reference/endpoint/credit/post-credittransfer) endpoint to get a transfer transaction.

Request Permit Data

This is endpoint receives transfer information, a permit signature and returns an [unsigned transaction](/api-reference/architecture/transaction-lifecycle) that executes the transfer. Permit data is obtained by calling the [Request Permit Data](/api-reference/endpoint/credit/post-creditpermitdata) endpoint and it is signed using the private key of the token holder. Transfer information needs to match the used to generate the permit. The unsigned transaction should be signed using your private key and can be broadcasted using [Execute Transaction](/api-reference/endpoint/transactions/post-transactionsexecute) or [Execute Transaction and Wait](/api-reference/endpoint/transactions/post-transactionsexecuteandwait) endpoints.

Transfer Credit Token

Execute Transaction

Execute transaction and wait for confirmation

Execute Transaction and Wait

Get User Profile

Get Leaderboard

Create Webhook

List Webhooks

Get Webhook

Update Webhook

Delete Webhook

Get Webhook Logs

Trigger Webhook Verification

Get Webhook Secret

Generate New Webhook Secret

Overview

Dashboard

Discord

Github

How OPENFORMAT creates and broadcasts transactions

Transaction Lifecycle

Reading on-chain Data

Learn how to integrate your application with OPENFORMAT's webhook system to receive real-time notifications for specific events.

Overview

API

SDKs

Get Started

Setup

Rewards Platform ->

API ->

Typescript SDK ->

Overview

API

SDKs

​Setup

Rewards Platform ->

API ->

Typescript SDK ->

Setup