Pular para o conteúdo principal
GET
/
data
/
events
Get Events
curl --request GET \
  --url https://data-api.voxfi.com.br/v1/data/events \
  --header 'x-api-key: <x-api-key>'
[
  {
    "category": "<string>",
    "category_id": 123,
    "created_at": "<string>",
    "created_by": "<string>",
    "description": "<string>",
    "documentation_url": "<string>",
    "finished_at": "<string>",
    "id": "<string>",
    "is_single_market": true,
    "likes": 123,
    "liquidity": 123,
    "markets": [
      {
        "closed_at": "<string>",
        "description": "<string>",
        "event_id": "<string>",
        "id": "<string>",
        "liquidity": 123,
        "metadata": [
          123
        ],
        "options": [
          {
            "description": "<string>",
            "event_id": "<string>",
            "id": "<string>",
            "market_id": "<string>",
            "metadata": [
              123
            ],
            "option_type": 123
          }
        ],
        "resolved_at": "<string>",
        "settled_at": "<string>",
        "thumbnail_url": "<string>",
        "volume": 123,
        "winner_option_type": 123
      }
    ],
    "metadata": [
      123
    ],
    "qty_markets": 123,
    "resolves_at": "<string>",
    "rules": "<string>",
    "slug": "<string>",
    "starts_at": "<string>",
    "status": "<string>",
    "status_id": 123,
    "tags": [
      "<string>"
    ],
    "tags_ids": [
      123
    ],
    "thumbnail_url": "<string>",
    "type": "<string>",
    "type_id": 123,
    "volume": 123
  }
]

Cabeçalhos

x-api-key
string
obrigatório

API Key

Parâmetros de consulta

page
integer

Page number

pageSize
integer

Page size

categoryId
integer

Category ID

tagId
integer

Tag ID

text
string

Text to search by description or tags

status
integer

Status ID

sort
string

Sort by

Resposta

OK

category
string
category_id
integer
created_at
string
created_by
string
description
string
documentation_url
string
finished_at
string
id
string
is_single_market
boolean
likes
integer
liquidity
integer
markets
object[]
metadata
integer[]
qty_markets
integer
resolves_at
string
rules
string
slug
string
starts_at
string
status
string
status_id
integer
tags
string[]
tags_ids
integer[]
thumbnail_url
string
type
string
type_id
integer
volume
integer