Membership Card

Add running xp

This endpoint allows add running xp for a user.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/add-xp

Path parameters

entityId*string

Query parameters

Header parameters

Body

xpnumber

Example: 10

forUserIdstring

Example: "user-123"

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/add-xp?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Get Membership for user

This endpoint allows get running xp for a user.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/xp

Path parameters

entityId*string

userId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

datanumber

Running XP for the user

tiernumber

Membership tier of the user

xpThresholdnumber

XP threshold for the user's membership tier

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/xp?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": false,
  "data": 0,
  "tier": 0,
  "xpThreshold": 0
}

Get DynamicNft for user

This endpoint allows get Multiple DynamicNft for a user.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/xp

Path parameters

entityId*string

Query parameters

Header parameters

Body

userIdsarray of string

Response

Successful response

Body

successboolean

Example: true

dataarray of DynamicNFT (object)

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/xp?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "userId": "text",
      "entityId": "text",
      "type": "text",
      "membershipTier": 0,
      "runningXP": 0,
      "totalXP": 0,
      "nftTokenId": "text",
      "name": "text",
      "title": "text",
      "description": "text",
      "image": "text",
      "animation_url": "text",
      "metadataIPFS": "text",
      "attributes": [
        {
          "display_type": "text",
          "trait_type": "text",
          "value": "text",
          "image": "text",
          "item_type": "text"
        }
      ],
      "createdAt": "2024-11-21T06:21:14.824Z"
    }
  ]
}

Get all membership cards of a user

This endpoint retrieves membership cards for a user.

GEThttps://api.questprotocol.xyz/api/mynfts

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataarray of MembershipCard (object)

Request

const response = await fetch('https://api.questprotocol.xyz/api/mynfts?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "userId": "user123",
      "entityId": "entity123",
      "type": "STATIC_MEDIA",
      "membershipTier": 2,
      "runningXP": 500,
      "totalXP": 1000,
      "nftTokenId": "token123",
      "name": "NFT Name",
      "title": "NFT Title",
      "description": "NFT Description",
      "image": "https://example.com/nft/image.jpg",
      "animation_url": "https://example.com/nft/animation.mp4",
      "metadataIPFS": "ipfs://metadata123",
      "attributes": [
        {
          "display_type": "boost_percentage",
          "trait_type": "skill",
          "value": {
            "score": 85
          },
          "image": "https://example.com/badge/image.png",
          "item_type": "badge"
        }
      ],
      "createdAt": "2023-06-27T12:45:00Z"
    }
  ]
}

Get membership card details for an entity

This endpoint retrieves membership card details for an entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/mynfts

Path parameters

entityId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataMembershipCard (object)

entity_dataEntity (object)

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/mynfts?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "userId": "user123",
    "entityId": "entity123",
    "type": "STATIC_MEDIA",
    "membershipTier": 2,
    "runningXP": 500,
    "totalXP": 1000,
    "nftTokenId": "token123",
    "name": "NFT Name",
    "title": "NFT Title",
    "description": "NFT Description",
    "image": "https://example.com/nft/image.jpg",
    "animation_url": "https://example.com/nft/animation.mp4",
    "metadataIPFS": "ipfs://metadata123",
    "attributes": [
      {
        "display_type": "boost_percentage",
        "trait_type": "skill",
        "value": {
          "score": 85
        },
        "image": "https://example.com/badge/image.png",
        "item_type": "badge"
      }
    ],
    "createdAt": "2023-06-27T12:45:00Z"
  },
  "entity_data": {
    "id": "entity123",
    "entityURLAlias": "my-entity",
    "entityRecordIds": [
      "record1",
      "record2"
    ],
    "contracts": [
      "contract1",
      "contract2"
    ],
    "badgeContractAddress": "0x123abc",
    "dyNFTContractAddress": "0x456def",
    "themeContractAddress": "0x789ghi",
    "name": "My Entity",
    "openseaSlug": "my-entity-slug",
    "description": "This is my entity description.",
    "twitter": "myentity",
    "discord": "myentity#1234",
    "telegram": "myentity",
    "instagram": "myentity",
    "website": "https://myentity.com",
    "medium": "myentity",
    "imageUrl": "https://example.com/myentity.jpg",
    "bannerUrl": "https://example.com/myentity-banner.jpg",
    "isEnabled": false,
    "isPrivate": false,
    "chainSource": "OFF_CHAIN",
    "defaultDyNftThemeId": "0",
    "discordQuestWebhookURL": "https://example.com/discord-webhook",
    "modifiedAt": "2023-06-27T12:45:00Z",
    "createdAt": "2023-06-25T09:00:00Z",
    "plan": "FREE",
    "parentEntityId": "e-0000001"
  }
}

Recalculate users membership card

This endpoint recalculates a user's membership card.

GEThttps://api.questprotocol.xyz/api/hidden/entities/{entityId}/recalculate-mynft

Path parameters

entityId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/hidden/entities/{entityId}/recalculate-mynft?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true
}

Get all membership card themes for an entity

This endpoint retrieves all the membership card themes for an entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/themes

Path parameters

entityId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataarray of MembershipCardTheme (object)

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/themes?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "themeId": "theme123",
      "entityId": "entity123",
      "membershipTier": 2,
      "tokenId": "token123",
      "price": "0.1 ETH",
      "title": "Theme Title",
      "backgroundImage": "https://example.com/theme/background.jpg",
      "squareLogoImage": "https://example.com/theme/logo-square.png",
      "horizontalLogoImage": "https://example.com/theme/logo-horizontal.png",
      "backgroundColor": "#FFFFFF",
      "accentColor1": "#FF0000",
      "accentColor2": "#00FF00",
      "metadataIPFS": "ipfs://metadata123",
      "attributes": [
        {
          "display_type": "boost_percentage",
          "trait_type": "skill",
          "value": {
            "score": 85
          }
        }
      ],
      "createdAt": "2023-06-27T12:45:00Z"
    }
  ]
}

Add new theme for an entity

This endpoint allows to add a new theme for an entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/themes

Path parameters

entityId*string

Query parameters

Header parameters

Body

membershipTier*number

Example: 10

title*string

Example: "dummy-title"

price*string

Example: "100 $"

backgroundImageIPFSstring

Example: "image-ipfs"

horizontalLogoImageIPFSstring

Example: "image-ipfs"

squareLogoImageIPFSstring

Example: "image-ipfs"

backgroundColorstring

Example: "red"

accentColor1string

Example: "red"

accentColor2string

Example: "red"

metadataIPFSstring

Example: "ipfs"

Response

Successful response

Body

successboolean

Example: true

themeIdstring

Example: "theme-101"

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/themes?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "dummy-title",
      "price": "100 $",
      "membershipTier": 10
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "themeId": "theme-101"
}

Get membership card themes details for an entity

This endpoint retrieves the membership card themes details for an entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/themes/{themeId}

Path parameters

entityId*string

themeId*string

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataMembershipCardTheme (object)

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/themes/{themeId}', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "themeId": "theme123",
    "entityId": "entity123",
    "membershipTier": 2,
    "tokenId": "token123",
    "price": "0.1 ETH",
    "title": "Theme Title",
    "backgroundImage": "https://example.com/theme/background.jpg",
    "squareLogoImage": "https://example.com/theme/logo-square.png",
    "horizontalLogoImage": "https://example.com/theme/logo-horizontal.png",
    "backgroundColor": "#FFFFFF",
    "accentColor1": "#FF0000",
    "accentColor2": "#00FF00",
    "metadataIPFS": "ipfs://metadata123",
    "attributes": [
      {
        "display_type": "boost_percentage",
        "trait_type": "skill",
        "value": {
          "score": 85
        }
      }
    ],
    "createdAt": "2023-06-27T12:45:00Z"
  }
}

Update theme for an entity

This endpoint allows to update a new theme for an entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/themes/{themeId}/update

Path parameters

entityId*string

themeId*string

Query parameters

Header parameters

Body

membershipTier*number

Example: 10

title*string

Example: "dummy-title"

price*string

Example: "100 $"

backgroundImageIPFS*string

Example: "image-ipfs"

horizontalLogoImageIPFS*string

Example: "image-ipfs"

squareLogoImageIPFS*string

Example: "image-ipfs"

backgroundColorstring

Example: "red"

accentColor1string

Example: "red"

accentColor2string

Example: "red"

metadataIPFSstring

Example: "ipfs"

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/themes/{themeId}/update?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "dummy-title",
      "price": "100 $",
      "membershipTier": 10,
      "backgroundImageIPFS": "image-ipfs",
      "squareLogoImageIPFS": "image-ipfs",
      "horizontalLogoImageIPFS": "image-ipfs"
    }),
});
const data = await response.json();

Response

{
  "success": true
}

Delete theme for an entity

This endpoint allows to delete a theme for an entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/themes/{themeId}/delete

Path parameters

entityId*string

themeId*string

Query parameters

Header parameters

Body

The request body is an empty object.

object

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/themes/{themeId}/delete?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

{
  "success": true
}

set default theme for an entity

This endpoint allows to set a default theme for an entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/themes/default

Path parameters

entityId*string

Query parameters

Header parameters

Body

themeId*string

Example: "theme-101"

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/themes/default?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "themeId": "theme-101"
    }),
});
const data = await response.json();

Response

{
  "success": true
}

Get XP for a specific entity

Retrieve the XP (experience points) for a specific entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/xp

Path parameters

entityId*string

ID of the entity to get XP for

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

datanumber

Example: 500

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/xp?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": 500
}

Get XP for multiple entities

Retrieve the XP (experience points) for multiple entities.

POSThttps://api.questprotocol.xyz/api/entities/xp

Query parameters

Header parameters

Body

entityIds*array of string

Response

Successful response

Body

successboolean

Example: true

dataarray of object

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/xp?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "entityIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "entityId": "entity123",
      "runningXP": 500
    }
  ]
}

Get XP history for a user in a specific entity

Retrieve the XP history for a specific user in a specific entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/xp-history

Path parameters

entityId*string

The ID of the entity.

userId*string

The ID of the user.

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataarray of object

pageinteger

Example: 1

totalCountinteger

Example: 50

totalPagesinteger

Example: 3

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/xp-history?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "userId": "user123",
      "entityId": "entity456",
      "xp": 500,
      "title": "XP Gain",
      "createdAt": "2023-01-01T12:00:00Z"
    }
  ],
  "page": 1,
  "totalCount": 50,
  "totalPages": 3
}

Get XP leaderboard for a specific entity

Retrieve the XP leaderboard for a specific entity, showing users with the highest XP.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/xp-leaderboard

Path parameters

entityId*string

The ID of the entity.

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataarray of object

pageinteger

Example: 1

totalCountinteger

Example: 50

totalPagesinteger

Example: 3

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/xp-leaderboard?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "userId": "user123",
      "imageUrl": "https://example.com/user123.jpg",
      "name": "John Doe",
      "runningXP": 500
    }
  ],
  "page": 1,
  "totalCount": 50,
  "totalPages": 3
}

Get user XP leaderboard rank

Retrieve the XP leaderboard rank for a specific user in a given entity. The response includes the user's position, threshold information, and whether the user is within the specified threshold.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/xp-leaderboard-rank

Path parameters

entityId*string

The ID of the entity

userId*string

The ID of the user

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/xp-leaderboard-rank?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "position": 1,
    "threshold": "5%",
    "isUserInThreshold": true
  }
}

Get all tags an entity

This endpoint retrieves all the tags of an entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/tags

Path parameters

entityId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/tags?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "tagId": "tag-121",
    "tagName": "super-tag",
    "description": "This is our tag",
    "tagUsers": [
      "user-11",
      "user-33"
    ],
    "isPrivate": false
  }
}

PreviousApp Metric NextEntity Tag

Last updated 10 months ago