Polls API endpoints

The latest documentation for endpoint is always on the DevPortal: https://partner.socios.com/devportal/apis/d93ca9b9-6e1f-4ec7-813e-a4e8c3c1d658/test

Endpoint to get a list of polls using search filters

GEThttps://api-public.socios.com/polls/1.0.8/polls

Authorization

Query parameters

Response

Search for polls succeeded for GET /poll/polls

Body

dataPoll (object)

Request

const response = await fetch('https://api-public.socios.com/polls/1.0.8/polls', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "id": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
    "partnerId": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
    "partnerName": "Example name",
    "partnerImages": [
      {
        "url": "https://url.com/partner/d66eb9d2-56c6-4b1b-8f56-31f8aa319abe/partner_logo/38aca876-86a8-4a10-a0e8-b0859614c8b3.png?version=1653577420",
        "type": "png",
        "format": "desktop",
        "width": "500",
        "height": "500"
      }
    ],
    "question": "What skins should Team Vitality play game 2 of MSI?",
    "openAt": "text",
    "publicationDate": "text",
    "closeAt": "text",
    "disclosedAt": "text",
    "type": "engagement",
    "isBound": false,
    "isQuorumReached": false,
    "quorum": "0.2",
    "currentQuorumPercentage": "0.2",
    "usedTokenCount": 4,
    "tokenLimit": 3000,
    "status": "cancelled",
    "information": "Lorem ipsum",
    "answers": [
      {
        "id": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
        "answer": "We should go west!",
        "votePercentage": "15.7",
        "totalVoteTokensUsed": 15,
        "statistics": {
          "uniqueAnswerVoteCount": 2
        }
      }
    ],
    "statistics": {
      "uniqueVoteCount": 2
    },
    "blockchainAddress": "0x000000000000000"
  }
}

Endpoint to get a single poll by id

GEThttps://api-public.socios.com/polls/1.0.8/poll/{pollId}

Authorization

Path parameters

pollId*string

Poll Id to be retrieved

Response

Success response

Body

dataPoll (object)

Request

const response = await fetch('https://api-public.socios.com/polls/1.0.8/poll/{pollId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "id": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
    "partnerId": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
    "partnerName": "Example name",
    "partnerImages": [
      {
        "url": "https://url.com/partner/d66eb9d2-56c6-4b1b-8f56-31f8aa319abe/partner_logo/38aca876-86a8-4a10-a0e8-b0859614c8b3.png?version=1653577420",
        "type": "png",
        "format": "desktop",
        "width": "500",
        "height": "500"
      }
    ],
    "question": "What skins should Team Vitality play game 2 of MSI?",
    "openAt": "text",
    "publicationDate": "text",
    "closeAt": "text",
    "disclosedAt": "text",
    "type": "engagement",
    "isBound": false,
    "isQuorumReached": false,
    "quorum": "0.2",
    "currentQuorumPercentage": "0.2",
    "usedTokenCount": 4,
    "tokenLimit": 3000,
    "status": "cancelled",
    "information": "Lorem ipsum",
    "answers": [
      {
        "id": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
        "answer": "We should go west!",
        "votePercentage": "15.7",
        "totalVoteTokensUsed": 15,
        "statistics": {
          "uniqueAnswerVoteCount": 2
        }
      }
    ],
    "statistics": {
      "uniqueVoteCount": 2
    },
    "blockchainAddress": "0x000000000000000"
  }
}

Vote on a poll

POSThttps://api-public.socios.com/polls/1.0.8/user/poll/{pollId}/vote

Authorization

Path parameters

pollId*string

Poll Id to vote for

Body

AnswerVote JSON data to create a new answerVote.

answerId*string (uuid)

Response

AnswerVote Created successfully on POST /poll/{pollId}/vote

Request

const response = await fetch('https://api-public.socios.com/polls/1.0.8/user/poll/{pollId}/vote', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "answerId": "35de3eda-fc2f-4f15-be0a-17cbdef6630f"
    }),
});
const data = await response.json();

Endpoint to get a single poll by id & userId

GEThttps://api-public.socios.com/polls/1.0.8/user/poll/{pollId}

Authorization

Path parameters

pollId*string

Poll Id to be retrieved

Response

Success response

Body

dataUserPoll (object)

Request

const response = await fetch('https://api-public.socios.com/polls/1.0.8/user/poll/{pollId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "id": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
    "partnerId": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
    "partnerName": "Example name",
    "partnerImages": [
      {
        "url": "https://url.com/partner/d66eb9d2-56c6-4b1b-8f56-31f8aa319abe/partner_logo/38aca876-86a8-4a10-a0e8-b0859614c8b3.png?version=1653577420",
        "type": "png",
        "format": "desktop",
        "width": "500",
        "height": "500"
      }
    ],
    "question": "What skins should Team Vitality play game 2 of MSI?",
    "openAt": "text",
    "closeAt": "text",
    "publicationDate": "text",
    "disclosedAt": "text",
    "isBound": false,
    "isQuorumReached": false,
    "quorum": "0.2",
    "currentQuorumPercentage": "0.2",
    "usedTokenCount": 4,
    "tokenLimit": 3000,
    "status": "cancelled",
    "information": "Lorem ipsum",
    "answers": [
      {
        "id": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
        "answer": "We should go west!",
        "votePercentage": "15.7",
        "totalVoteTokensUsed": 15,
        "statistics": {
          "uniqueAnswerVoteCount": 2
        },
        "voteStatus": "rejected"
      }
    ],
    "statistics": {
      "uniqueVoteCount": 2
    },
    "userVote": true,
    "blockchainAddress": "0x000000000000000"
  }
}

Endpoint to get a list of polls using search filters

GEThttps://api-public.socios.com/polls/1.0.8/user/polls

Authorization

Query parameters

Response

Search for user polls succeeded for GET /user/polls

Body

dataUserPoll (object)

Request

const response = await fetch('https://api-public.socios.com/polls/1.0.8/user/polls', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "id": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
    "partnerId": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
    "partnerName": "Example name",
    "partnerImages": [
      {
        "url": "https://url.com/partner/d66eb9d2-56c6-4b1b-8f56-31f8aa319abe/partner_logo/38aca876-86a8-4a10-a0e8-b0859614c8b3.png?version=1653577420",
        "type": "png",
        "format": "desktop",
        "width": "500",
        "height": "500"
      }
    ],
    "question": "What skins should Team Vitality play game 2 of MSI?",
    "openAt": "text",
    "closeAt": "text",
    "publicationDate": "text",
    "disclosedAt": "text",
    "isBound": false,
    "isQuorumReached": false,
    "quorum": "0.2",
    "currentQuorumPercentage": "0.2",
    "usedTokenCount": 4,
    "tokenLimit": 3000,
    "status": "cancelled",
    "information": "Lorem ipsum",
    "answers": [
      {
        "id": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
        "answer": "We should go west!",
        "votePercentage": "15.7",
        "totalVoteTokensUsed": 15,
        "statistics": {
          "uniqueAnswerVoteCount": 2
        },
        "voteStatus": "rejected"
      }
    ],
    "statistics": {
      "uniqueVoteCount": 2
    },
    "userVote": true,
    "blockchainAddress": "0x000000000000000"
  }
}

Endpoint to get a list of user polls history

GEThttps://api-public.socios.com/polls/1.0.8/user/polls/history

Authorization

Query parameters

Response

Search for user polls succeeded for GET /user/polls/history

Body

dataUserPoll (object)

Request

const response = await fetch('https://api-public.socios.com/polls/1.0.8/user/polls/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "id": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
    "partnerId": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
    "partnerName": "Example name",
    "partnerImages": [
      {
        "url": "https://url.com/partner/d66eb9d2-56c6-4b1b-8f56-31f8aa319abe/partner_logo/38aca876-86a8-4a10-a0e8-b0859614c8b3.png?version=1653577420",
        "type": "png",
        "format": "desktop",
        "width": "500",
        "height": "500"
      }
    ],
    "question": "What skins should Team Vitality play game 2 of MSI?",
    "openAt": "text",
    "closeAt": "text",
    "publicationDate": "text",
    "disclosedAt": "text",
    "isBound": false,
    "isQuorumReached": false,
    "quorum": "0.2",
    "currentQuorumPercentage": "0.2",
    "usedTokenCount": 4,
    "tokenLimit": 3000,
    "status": "cancelled",
    "information": "Lorem ipsum",
    "answers": [
      {
        "id": "35de3eda-fc2f-4f15-be0a-17cbdef6630f",
        "answer": "We should go west!",
        "votePercentage": "15.7",
        "totalVoteTokensUsed": 15,
        "statistics": {
          "uniqueAnswerVoteCount": 2
        },
        "voteStatus": "rejected"
      }
    ],
    "statistics": {
      "uniqueVoteCount": 2
    },
    "userVote": true,
    "blockchainAddress": "0x000000000000000"
  }
}

PreviousPolls NextRewards

Last updated 1 month ago