Sales

Volume/units over time with buyer/seller/dual split

POST
/v1/sales/analytics/time-series

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/sales/analytics/time-series" \  -H "Content-Type: application/json" \  -d '{}'
{
  "current": [
    {
      "buyer": {
        "measureValue": 0,
        "units": 0,
        "volume": 0
      },
      "date": "string",
      "dual": {
        "measureValue": 0,
        "units": 0,
        "volume": 0
      },
      "seller": {
        "measureValue": 0,
        "units": 0,
        "volume": 0
      },
      "total": {
        "measureValue": 0,
        "units": 0,
        "volume": 0
      }
    }
  ],
  "measure": "string",
  "previous": [
    {
      "buyer": {
        "measureValue": 0,
        "units": 0,
        "volume": 0
      },
      "date": "string",
      "dual": {
        "measureValue": 0,
        "units": 0,
        "volume": 0
      },
      "seller": {
        "measureValue": 0,
        "units": 0,
        "volume": 0
      },
      "total": {
        "measureValue": 0,
        "units": 0,
        "volume": 0
      }
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Market summary with buyer/seller/dual split + previous period POST

Previous Page

Mint a scoped search token GET

Returns a short-lived scoped search token plus the host to query, so a trusted client can search the entity indexes directly with per-query controls (e.g. attributesToSearchOn for name-only matching).