Torque API

GET/campaigns/{campaignId}

Path parameters

campaignId*string

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/campaigns/{campaignId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "campaign": {
      "id": "text",
      "pubKey": "text",
      "title": "text",
      "type": "text",
      "imageUrl": "text",
      "description": "text",
      "content": "text",
      "advertiserPubKey": "text",
      "targetLink": "text",
      "offerLink": "text",
      "offerTheme": "DARK",
      "offerBgImage": "text",
      "startTime": "2024-11-21T09:01:31.880Z",
      "endTime": "2024-11-21T09:01:31.880Z",
      "userRewardType": "POINTS",
      "userRewardToken": "text",
      "publisherRewardType": "POINTS",
      "publisherRewardToken": "text",
      "totalConversions": 0,
      "remainingConversions": 0,
      "asymmetricRewards": [],
      "status": "text",
      "blinkOnly": false,
      "hideRewards": false,
      "advertiser": {
        "username": "text",
        "twitter": "text",
        "profileImage": "text",
        "blueChipAdvertiser": false
      },
      "requirements": [
        {
          "id": "text",
          "type": "text"
        }
      ],
      "audiences": [
        {
          "id": "text",
          "title": "text"
        }
      ],
      "userPayouts": [
        {
          "user": {
            "pubKey": "text",
            "username": "text",
            "twitter": "text",
            "profileImage": "text"
          },
          "payoutTx": "text"
        }
      ],
      "pendingConversions": 0,
      "lootBoxRewards": {
        "id": "text",
        "tokenAddress": "text",
        "rewards": [
          {
            "amount": 0,
            "users": 0
          }
        ]
      }
    }
  }
}

GET/campaigns

Query parameters

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*any of

objectobject

Request

JavaScriptCurlPython

const response = await fetch('/campaigns', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "campaigns": [
      {
        "id": "text",
        "pubKey": "text",
        "title": "text",
        "type": "text",
        "imageUrl": "text",
        "description": "text",
        "content": "text",
        "advertiserPubKey": "text",
        "targetLink": "text",
        "offerLink": "text",
        "offerTheme": "DARK",
        "offerBgImage": "text",
        "startTime": "2024-11-21T09:01:31.880Z",
        "endTime": "2024-11-21T09:01:31.880Z",
        "userRewardType": "POINTS",
        "userRewardToken": "text",
        "publisherRewardType": "POINTS",
        "publisherRewardToken": "text",
        "totalConversions": 0,
        "remainingConversions": 0,
        "asymmetricRewards": [],
        "status": "text",
        "blinkOnly": false,
        "hideRewards": false,
        "advertiser": {
          "username": "text",
          "twitter": "text",
          "profileImage": "text",
          "blueChipAdvertiser": false
        },
        "requirements": [
          {
            "id": "text",
            "type": "text"
          }
        ],
        "audiences": [
          {
            "id": "text",
            "title": "text"
          }
        ],
        "userPayouts": [
          {
            "user": {
              "pubKey": "text",
              "username": "text",
              "twitter": "text",
              "profileImage": "text"
            },
            "payoutTx": "text"
          }
        ],
        "pendingConversions": 0,
        "lootBoxRewards": {
          "id": "text",
          "tokenAddress": "text",
          "rewards": [
            {
              "amount": 0,
              "users": 0
            }
          ]
        }
      }
    ]
  }
}

GET/identify

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/identify', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "payload": {
      "statement": "text",
      "issuedAt": "text",
      "expirationTime": "text"
    }
  }
}

GET/leaderboards

Query parameters

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/leaderboards?campaignId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "campaignName": "text",
    "leaderboard": [
      {
        "user": "text",
        "profileImage": "text",
        "conversions": 0
      }
    ]
  }
}

POST/journey/start

Body

application/json

campaignId*string

publisherHandle*string

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

Request

JavaScriptCurlPython

const response = await fetch('/journey/start', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "campaignId": "text",
      "publisherHandle": "text"
    }),
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS"
}

POST/journey

Body

application/json

programAddressstring

userPubKeystring

txHashstring

event*any of

objectobjectobjectobjectobjectobjectobjectobjectobjectobjectobject

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

dataobject

Request

JavaScriptCurlPython

const response = await fetch('/journey', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "event": {
        "eventType": "CLICK",
        "campaignId": "text",
        "publisherHandle": "text"
      }
    }),
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "transaction": "text"
  }
}

GET/logout

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/logout', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "cleared": false
  }
}

POST/login

Body

application/json

authTypeenum

siwsbasic

pubKey*string

payload*object

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pubKey": "text",
      "payload": {}
    }),
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "token": "text",
    "verified": false,
    "pubKey": "text",
    "twitter": "text",
    "profileImage": "text",
    "publisherPubKey": "text",
    "isPublisher": false,
    "username": "text"
  }
}

POST/tx/build

Body

application/json

createCampaignobject

endCampaignobject

createPublisherboolean

payoutPublisherobject

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

dataany

Request

JavaScriptCurlPython

const response = await fetch('/tx/build', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS"
}

POST/tx/execute

Body

application/json

createCampaignobject

endCampaignobject

createPublisherobject

payoutPublisherobject

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/tx/execute', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "signature": "text",
    "campaignId": "text"
  }
}

GET/users/campaigns

Query parameters

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/users/campaigns?publisher=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "campaigns": [
      {
        "id": "text",
        "pubKey": "text",
        "title": "text",
        "type": "text",
        "imageUrl": "text",
        "description": "text",
        "content": "text",
        "advertiserPubKey": "text",
        "targetLink": "text",
        "offerLink": "text",
        "offerTheme": "DARK",
        "offerBgImage": "text",
        "startTime": "2024-11-21T09:01:31.880Z",
        "endTime": "2024-11-21T09:01:31.880Z",
        "userRewardType": "POINTS",
        "userRewardToken": "text",
        "publisherRewardType": "POINTS",
        "publisherRewardToken": "text",
        "totalConversions": 0,
        "remainingConversions": 0,
        "asymmetricRewards": [],
        "status": "text",
        "blinkOnly": false,
        "hideRewards": false,
        "advertiser": {
          "username": "text",
          "twitter": "text",
          "profileImage": "text",
          "blueChipAdvertiser": false
        },
        "requirements": [
          {
            "id": "text",
            "type": "text"
          }
        ],
        "audiences": [
          {
            "id": "text",
            "title": "text"
          }
        ],
        "userPayouts": [
          {
            "user": {
              "pubKey": "text",
              "username": "text",
              "twitter": "text",
              "profileImage": "text"
            },
            "payoutTx": "text"
          }
        ],
        "pendingConversions": 0,
        "lootBoxRewards": {
          "id": "text",
          "tokenAddress": "text",
          "rewards": [
            {
              "amount": 0,
              "users": 0
            }
          ]
        }
      }
    ]
  }
}

GET/users/journey

Query parameters

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/users/journey', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "journeys": [
      {
        "campaignId": "text",
        "userPubKey": "text",
        "status": "STARTED",
        "publisherPubKey": "text",
        "createdAt": "2024-11-21T09:01:31.880Z",
        "updatedAt": "2024-11-21T09:01:31.880Z",
        "campaign": {
          "id": "text",
          "pubKey": "text",
          "title": "text",
          "type": "text",
          "imageUrl": "text",
          "description": "text",
          "content": "text",
          "advertiserPubKey": "text",
          "targetLink": "text",
          "offerLink": "text",
          "offerTheme": "DARK",
          "offerBgImage": "text",
          "startTime": "2024-11-21T09:01:31.880Z",
          "endTime": "2024-11-21T09:01:31.880Z",
          "userRewardType": "POINTS",
          "userRewardToken": "text",
          "publisherRewardType": "POINTS",
          "publisherRewardToken": "text",
          "totalConversions": 0,
          "remainingConversions": 0,
          "asymmetricRewards": [],
          "status": "text",
          "blinkOnly": false,
          "hideRewards": false,
          "advertiser": {
            "username": "text",
            "twitter": "text",
            "profileImage": "text",
            "blueChipAdvertiser": false
          },
          "requirements": [
            {
              "id": "text",
              "type": "text"
            }
          ],
          "audiences": [
            {
              "id": "text",
              "title": "text"
            }
          ],
          "userPayouts": [
            {
              "user": {
                "pubKey": "text",
                "username": "text",
                "twitter": "text",
                "profileImage": "text"
              },
              "payoutTx": "text"
            }
          ],
          "pendingConversions": 0,
          "lootBoxRewards": {
            "id": "text",
            "tokenAddress": "text",
            "rewards": [
              {
                "amount": 0,
                "users": 0
              }
            ]
          }
        },
        "userBountySteps": [
          {
            "id": "text",
            "bountyStepId": "text",
            "userJourneyId": "text",
            "status": "STARTED",
            "transaction": "text"
          }
        ],
        "startTime": "2024-11-21T09:01:31.880Z",
        "startTx": "text"
      }
    ]
  }
}

GET/users/me

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/users/me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "token": "text",
    "verified": false,
    "pubKey": "text",
    "twitter": "text",
    "profileImage": "text",
    "publisherPubKey": "text",
    "isPublisher": false,
    "telegram": "text",
    "username": "text"
  }
}

GET/users/payout

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/users/payout', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "signatures": [
      "text"
    ]
  }
}

GET/offers/{publicKey}

Path parameters

publicKey*string

Query parameters

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/offers/{publicKey}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "campaigns": [
      {
        "id": "text",
        "pubKey": "text",
        "title": "text",
        "type": "text",
        "imageUrl": "text",
        "description": "text",
        "content": "text",
        "advertiserPubKey": "text",
        "targetLink": "text",
        "offerLink": "text",
        "offerTheme": "DARK",
        "offerBgImage": "text",
        "startTime": "2024-11-21T09:01:31.880Z",
        "endTime": "2024-11-21T09:01:31.880Z",
        "userRewardType": "POINTS",
        "userRewardToken": "text",
        "publisherRewardType": "POINTS",
        "publisherRewardToken": "text",
        "totalConversions": 0,
        "remainingConversions": 0,
        "asymmetricRewards": [],
        "status": "text",
        "blinkOnly": false,
        "hideRewards": false,
        "advertiser": {
          "username": "text",
          "twitter": "text",
          "profileImage": "text",
          "blueChipAdvertiser": false
        },
        "requirements": [
          {
            "id": "text",
            "type": "text"
          }
        ],
        "audiences": [
          {
            "id": "text",
            "title": "text"
          }
        ],
        "userPayouts": [
          {
            "user": {
              "pubKey": "text",
              "username": "text",
              "twitter": "text",
              "profileImage": "text"
            },
            "payoutTx": "text"
          }
        ],
        "pendingConversions": 0,
        "lootBoxRewards": {
          "id": "text",
          "tokenAddress": "text",
          "rewards": [
            {
              "amount": 0,
              "users": 0
            }
          ]
        }
      }
    ]
  }
}

GET/audiences/verify

Query parameters

Response

200201400401403404500

Default Response

Body

application/json

status*enum

SUCCESS

data*object

Request

JavaScriptCurlPython

const response = await fetch('/audiences/verify?publicKey=text&campaignId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "status": "SUCCESS",
  "data": {
    "valid": false
  }
}

POST/actions/{publisherHandle}/{campaignId}

Path parameters

campaignId*string

publisherHandle*string

Query parameters

Body

application/json

account*string

Response

200201400401403404500

Default Response

Body

application/json

typestring

externalLinkstring

transactionstring

messagestring

datanullable string

nextany

hrefstring

iconstring

titlestring

descriptionstring

labelstring

linksany

Request

JavaScriptCurlPython

const response = await fetch('/actions/{publisherHandle}/{campaignId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "account": "text"
    }),
});
const data = await response.json();

Response

200201400401403404500

{
  "type": "text",
  "externalLink": "text",
  "transaction": "text",
  "message": "text",
  "data": "text",
  "href": "text",
  "icon": "text",
  "title": "text",
  "description": "text",
  "label": "text"
}

GET/actions/{publisherHandle}/{campaignId}

Path parameters

campaignId*string

publisherHandle*string

Query parameters

Response

200201400401403404500

Default Response

Body

application/json

icon*string

title*string

description*string

label*string

disabledboolean

linksobject

errorobject

Request

JavaScriptCurlPython

const response = await fetch('/actions/{publisherHandle}/{campaignId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404500

{
  "icon": "text",
  "title": "text",
  "description": "text",
  "label": "text",
  "disabled": false,
  "links": {
    "actions": [
      {
        "href": "text",
        "label": "text",
        "parameters": [
          {
            "name": "text",
            "label": "text",
            "type": "text",
            "required": false,
            "options": [
              {
                "label": "text",
                "value": "text"
              }
            ]
          }
        ]
      }
    ]
  },
  "error": {
    "message": "text"
  }
}