Skip to main content

DegenScore Public API (1.0)

Download OpenAPI specification:Download

DegenScore Team: [email protected]

This public API can be used by anyone who wants to integrate the DegenScore Beacon in their product or wants to read Beacon Data.

BeaconService

API to fetch data about degenscore Beacons

Get Beacon Info

path Parameters
beaconAddress
required
string

Responses

Response Schema: application/json
name
string

General name for the DegenScore Beacon

description
string

Description for the DegenScore Beacon

image
string

URL of the Beacon image

object

Do not use! Only for ERC1155 compatibility. Contains the scores of the beacon Traits.

updatedAt
string <date-time>

Timestamp of when the user last updated the beacon

external_url
string

Link to the beacon page on degenscore.com

animation_url
string

URL of the animated beacon image

object

Contains the Beacon traits.

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "image": "string",
  • "properties": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "external_url": "string",
  • "animation_url": "string",
  • "traits": {
    }
}

List Beacons

query Parameters
limit
integer <int32>
Default: "10"

Limit for pagination. (Max 200)

cursor
string

Cursor from previous page

Responses

Response Schema: application/json
Array of objects (Item)
object (Meta)

Response samples

Content type
application/json
{
  • "beacons": [
    ],
  • "meta": {
    }
}

Get Trait Info

path Parameters
traitId
required
string

Responses

Response Schema: application/json
name
string

Name of the trait

description
string

The description of the trait

image
string

The image URL of the trait

id
string

The api ID of the trait

Response samples

Content type
application/json
{
  • "name": "DegenScore Trait - DegenScore",
  • "description": "How good of a crypto user are you?\nThe DegenScore stands for how good of a crypto user you are: mastery of protocols, risk taking skills, winning and helping others win across crypto.\nThe score is calculated using your on-chain history across the addresses privately bundled in your Beacon.",
  • "properties": {
    }
}

Beacon Info Response

name
string

General name for the DegenScore Beacon

description
string

Description for the DegenScore Beacon

image
string

URL of the Beacon image

object

Do not use! Only for ERC1155 compatibility. Contains the scores of the beacon Traits.

updatedAt
string <date-time>

Timestamp of when the user last updated the beacon

external_url
string

Link to the beacon page on degenscore.com

animation_url
string

URL of the animated beacon image

object

Contains the Beacon traits.

{
  • "name": "string",
  • "description": "string",
  • "image": "string",
  • "properties": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "external_url": "string",
  • "animation_url": "string",
  • "traits": {
    }
}

List Beacons Response

Array of objects (Item)
object (Meta)
{
  • "beacons": [
    ],
  • "meta": {
    }
}

Trait Info Response

name
string

Name of the trait

description
string

The description of the trait

image
string

The image URL of the trait

id
string

The api ID of the trait

{
  • "name": "DegenScore Trait - DegenScore",
  • "description": "How good of a crypto user are you?\nThe DegenScore stands for how good of a crypto user you are: mastery of protocols, risk taking skills, winning and helping others win across crypto.\nThe score is calculated using your on-chain history across the addresses privately bundled in your Beacon.",
  • "properties": {
    }
}

DegenScore Trait

updatedAt
string <date-time>

The timestamp of when the trait was last updated

{
  • "updatedAt": "2023-05-10T16:33:40Z"
}

Actions Trait

Array of objects (A on-chain action of this user)

Actions of this beacon owner

Array
name
string

Name of the action

description
string

The description of the action

actionTier
string (ActionTier)
Enum: "ACTION_TIER_COMMON" "ACTION_TIER_UNCOMMON" "ACTION_TIER_RARE" "ACTION_TIER_EPIC" "ACTION_TIER_LEGENDARY"
{
  • "actions": [
    ]
}

Activity Trait

title
string

The title according to the users activity

rank
string (Rank)
Enum: "RANK_LEGENDARY" "RANK_EPIC" "RANK_RARE" "RANK_COMMON"
object (CategoryMetric)
{
  • "title": "Reasonably active Blockspace Lord",
  • "rank": "RANK_LEGENDARY",
  • "categoryMetric": {
    }
}