OPENFORMAT

Overview

API References

Dashboard

Discord

Github

Get an API key to authenticate your user in our API.

Get an API key

Integrate rewards and reputation into your community in minutes.

Welcome

Get Started

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

API Overview

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.

Real-time Notifications

A full code example that generates an API key for a given Ethereum account.

Generate API Key

A full code example that rewards a given user 10 XP for completing an activity in an application.

Reward XP

A full code example that transfers a Credit token from a holder account to a receiver.

Credit Transfers with Permit

API Reference

Quickstart

Create Badge

Reward Badge

Create dApp

We've partnered with no-code and low-code stacks to make it as easy as possible for builders and developers to experiment with web3 technologies.

Explore our case studies to see how builders are using no-code tools combined with our onchain game mechanics to rapidly build prototypes and applications.

Case Studies

[BuildShip](https://buildship.com/) is a visual backend builder that lets you ship APIs, scheduled jobs, backend cloud functions instantly. You can use BuildShip with OPENFORMAT templates to create web3 apps fast. Get started with one of the templates below.

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

Trigger XP in your application when a user completes a specific action, such as registering, completing a task, watching a video or posting a comment. This is endpoint returns an [unsigned transaction](/api-reference/architecture/transaction-lifecycle), which can now be signed in your application using your private key held in your local environment variables. Once signed, 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.

Trigger a reward of a specific Credit token in your application. This is endpoint returns an [unsigned transaction](/api-reference/architecture/transaction-lifecycle), which can be signed using your private key held in your local environment variables. Once signed, 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.

By default this operation transfers the rewarded tokens from the transaction sender account to the receiver account, this transfer is executed by the Application contract defined in `app_id` parameter. That means for the reward to succeed you should had previously created an allowance for the Application to transfer the required amount of tokens; you can do this using our [approve endpoint](/api-reference/endpoint/credit/post-creditapprove)

In case you want to mint the new tokens instead of transfer them you should set the optional parameter `mint` to `true`

Reward Credit

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.

Overview

API

SDKs

No-Code

Get an API key