Node Inputs

Node Outputs

What’s next?

Dashboard

Community

Blog

GitHub

Roadmap

OPENFORMAT

API Reference

SDKs

Cookbook

No-code

Start Building

Support

Returns a leaderboard based on the amount of experience points (XP) users have earned.

Get Leaderboard

We're building the decentralised framework to integrate **rewards**, **micro-transactions**, **revenue splitting** and **new business models** into your apps. 

Welcome

Why Decentralisation?

Who's it for?

Create your first OPENFORMAT App to starting rewarding your users with XP, Tokens and Badges.

Create Application

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

Get an API key

Learn how to trigger your first reward with OPENFORMAT

Trigger your first Reward

Accounts & Profiles

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

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

API Overview

Quickstart

Reward XP

Create Badge

Reward Badge

Use our React SDK to connect your users via a web3 wallet.

React

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.

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.

Overview

Creates a web3 account for your user. You can learn more about web3 accounts in [Accounts & Profiles](../../../functions/accounts-and-profiles) in the key concepts section.

Create web3 Account

Reward a user with experience points (XP) for completing an action.

Reward a user with a badge for completing an action or mission.

Returns the user's experience point (XP) balance, the badges they have collected and the actions they have completed within that specific dApp.

Get User Information

Checks whether the user has completed all of the actions that make up a mission, and whether they have already been rewarded for completing the mission.

Check Missions

Reward your existing users with on-chain experience points (XP). This template handles the process of issuing XP directly to users based on their unique identifier, making it easy to integrate gamification into your existing application.

XP Rewards Integration

Create a leaderboard which includes the names and images of the users within your app, by linking to your database. This leaderboard is based off the amount of on-chain experience points (XP) the users have earned.

Leaderboard

Easily integrate location-based rewards into your app. This template verifies user presence at specific locations using a set of given coords and automatically issues on-chain badges to their web3 account. Perfect for gamification, enhancing user engagement, and promoting exploration.

Geolocation Reward

Verify on-chain whether a given web3 account holds a specific badge. It's ideal for both online and offline access control.

Badge Access Verifier

Calculate your users level and their progression towards the next level based on the on-chain experience points (XP) they have earned. The XP requirements for levelling can be customised to determine how quickly the user progresses.

Level Progression Tracker

Checks whether a user has completed all the actions that make up a mission, and if they have, it rewards them with the appropriate XP and badges.

Check and Reward Missions

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](/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.

Key	Description
`API Key`	Your OPENFORMAT API Key.
`dApp ID`	The ID for your OPENFORMAT dApp.
`duration`	The time range that you want your leaderboard to cover.
`No. of Results`	The number of users shown in the leaderboard (i.e. top 10, top 50 or all).

Key	Description
`data.total`	The total number of items in the data array.
`data.data.user`	The account address of the user.
`data.data.xp_rewarded`	The total experience points rewarded to the user.

Introduction

BuildShip

​Node Inputs

​Node Outputs

​What’s next?

Node Inputs

Node Outputs

What’s next?