Skip to main content

Off-chain Integration

The easiest way of integrating the Beacon Traits is by using our metadata API. It returns all info about a users Beacon in a easily digestible JSON format.

To Beacon metadata can be fetched at:<beacon address>

The API returns all available data about a users beacon like: last beacon update or achieved traits.


When integrating the Beacon using the API it should be verified that the isConfirmed field is set to true. This indicates the beacon has been successfully confirmed on-chain. If the field is false the user should be treated as if he does not own a beacon.

Since the trait value is an integer it is required to interpret the value according to the Beacon Trait reference List