hubvibe-io.com

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "The 200 body of every paid /work call. `result` is the worker's own output (its schema is per route); everything else is the same on every /work route. A receipt for the job is at `receipt_url`.",
  "properties": {
    "attribution": {
      "$ref": "#/components/schemas/Attribution"
    },
    "billing_warning": {
      "description": "Present only when the charge was recorded with a caveat.",
      "examples": [
        "settlement pending"
      ],
      "type": "string"
    },
    "price_usd": {
      "description": "What this call cost, in USD.",
      "examples": [
        0.02
      ],
      "type": "number"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    },
    "receipt_id": {
      "description": "Receipt id for this job.",
      "examples": [
        "rcpt_9f1c2b3a4d5e6f70"
      ],
      "type": "string"
    },
    "receipt_url": {
      "description": "Where to fetch the machine-readable receipt (free, no payment).",
      "examples": [
        "/work/receipts/rcpt_9f1c2b3a4d5e6f70"
      ],
      "type": "string"
    },
    "result": {
      "properties": {
        "as_of": {
          "description": "The source's own update stamp.",
          "examples": [
            "2026-07-13"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "change": {
          "description": "Latest versus previous; null when either is missing.",
          "properties": {
            "absolute": {
              "description": "latest minus previous.",
              "examples": [
                0.43
              ],
              "type": "number"
            },
            "pct": {
              "description": "Change as a percentage of previous; null when previous is zero.",
              "examples": [
                15.69
              ],
              "type": [
                "number",
                "null"
              ]
            }
          },
          "required": [
            "absolute",
            "pct"
          ],
          "type": [
            "object",
            "null"
          ]
        },
        "checked_at": {
          "description": "When this node read the source (UTC). Nothing here is cached.",
          "examples": [
            "2026-09-26T18:00:00Z"
          ],
          "format": "date-time",
          "type": "string"
        },
        "country": {
          "description": "Where.",
          "properties": {
            "code": {
              "description": "Country code as the source spells it.",
              "examples": [
                "JP"
              ],
              "type": "string"
            },
            "name": {
              "description": "Country name from the source.",
              "examples": [
                "Japan"
              ],
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "code",
            "name"
          ],
          "type": "object"
        },
        "frequency": {
          "description": "Period of the observations.",
          "enum": [
            "annual",
            "monthly"
          ],
          "examples": [
            "annual"
          ],
          "type": "string"
        },
        "indicator": {
          "description": "What was measured.",
          "properties": {
            "alias": {
              "description": "Alias used; null for a raw code.",
              "examples": [
                "inflation"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "code": {
              "description": "World Bank indicator code; null for Eurostat monthly series.",
              "examples": [
                "FP.CPI.TOTL.ZG"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "name": {
              "description": "The source's name for the series.",
              "examples": [
                "Inflation, consumer prices (annual %)"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "unit": {
              "description": "Unit when the source states it.",
              "examples": [
                "% change on a year earlier (HICP)"
              ],
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "alias",
            "code",
            "name",
            "unit"
          ],
          "type": "object"
        },
        "latest": {
          "description": "Most recent published value; null when none in the window.",
          "properties": {
            "period": {
              "description": "Period.",
              "examples": [
                "2025"
              ],
              "type": "string"
            },
            "value": {
              "description": "Value.",
              "examples": [
                3.17
              ],
              "type": "number"
            }
          },
          "required": [
            "period",
            "value"
          ],
          "type": [
            "object",
            "null"
          ]
        },
        "notes": {
          "description": "Caveats; empty when none.",
          "examples": [
            []
          ],
          "items": {
            "description": "A caveat.",
            "examples": [
              "1 of 5 periods have no published value yet."
            ],
            "type": "string"
          },
          "type": "array"
        },
        "observation_count": {
          "description": "Observations returned.",
          "examples": [
            5
          ],
          "type": "integer"
        },
        "observations": {
          "description": "Oldest first.",
          "items": {
            "description": "One observation.",
            "properties": {
              "period": {
                "description": "Year (2025) or month (2026-08).",
                "examples": [
                  "2025"
                ],
                "type": "string"
              },
              "value": {
                "description": "Value; null when not yet published.",
                "examples": [
                  3.17
                ],
                "type": [
                  "number",
                  "null"
                ]
              }
            },
            "required": [
              "period",
              "value"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "previous": {
          "description": "The published value before it; null when none.",
          "properties": {
            "period": {
              "description": "Period.",
              "examples": [
                "2024"
              ],
              "type": "string"
            },
            "value": {
              "description": "Value.",
              "examples": [
                2.74
              ],
              "type": "number"
            }
          },
          "required": [
            "period",
            "value"
          ],
          "type": [
            "object",
            "null"
          ]
        },
        "source": {
          "description": "Which official source answered.",
          "enum": [
            "world-bank",
            "eurostat"
          ],
          "examples": [
            "world-bank"
          ],
          "type": "string"
        },
        "source_url": {
          "description": "Where the numbers came from.",
          "examples": [
            "https://api.worldbank.org/v2/country/JP/indicator/FP.CPI.TOTL.ZG?format=json"
          ],
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "indicator",
        "country",
        "frequency",
        "source",
        "observations",
        "observation_count",
        "latest",
        "previous",
        "change",
        "as_of",
        "source_url",
        "notes",
        "checked_at"
      ],
      "type": "object"
    },
    "status": {
      "const": "ok",
      "description": "Present only on a delivered result.",
      "type": "string"
    },
    "worker": {
      "description": "Catalog name of the worker that ran.",
      "examples": [
        "market.quote"
      ],
      "type": "string"
    }
  },
  "required": [
    "status",
    "worker",
    "price_usd",
    "result",
    "provenance",
    "receipt_id",
    "receipt_url"
  ],
  "title": "data.macro response",
  "type": "object"
}