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": {
        "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"
        },
        "limit_per_portal": {
          "description": "Results requested per portal.",
          "examples": [
            5
          ],
          "type": "integer"
        },
        "portals_failed": {
          "description": "Portals that did not answer, with the reason; never silently dropped.",
          "examples": [
            []
          ],
          "items": {
            "description": "A portal that failed for this call.",
            "properties": {
              "portal": {
                "description": "Portal id.",
                "examples": [
                  "data.gov.hk"
                ],
                "type": "string"
              },
              "reason": {
                "description": "Why it did not answer this call.",
                "examples": [
                  "data.gov.hk timed out"
                ],
                "type": "string"
              }
            },
            "required": [
              "portal",
              "reason"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "portals_ok": {
          "description": "Portals that answered.",
          "examples": [
            [
              "data.e-gov.go.jp",
              "catalog.data.metro.tokyo.lg.jp"
            ]
          ],
          "items": {
            "description": "Portal id.",
            "examples": [
              "data.e-gov.go.jp"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "portals_searched": {
          "description": "Portals the query was sent to.",
          "examples": [
            [
              "data.e-gov.go.jp",
              "catalog.data.metro.tokyo.lg.jp"
            ]
          ],
          "items": {
            "description": "Portal id.",
            "examples": [
              "data.e-gov.go.jp"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "query": {
          "description": "The query as given.",
          "examples": [
            "人口"
          ],
          "type": "string"
        },
        "region": {
          "description": "Region searched.",
          "examples": [
            "jp"
          ],
          "type": "string"
        },
        "result_count": {
          "description": "Datasets returned.",
          "examples": [
            10
          ],
          "type": "integer"
        },
        "results": {
          "description": "Datasets found, most recently updated first.",
          "items": {
            "description": "One dataset.",
            "properties": {
              "country": {
                "description": "ISO 3166-1 alpha-2.",
                "examples": [
                  "JP"
                ],
                "type": "string"
              },
              "description": {
                "description": "Description, up to 1000 characters.",
                "examples": [
                  "国勢調査の人口等基本集計..."
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "id": {
                "description": "Dataset id on the portal.",
                "examples": [
                  "5b2f1c7e-8a3d-4c1e-9f2a-1b2c3d4e5f60"
                ],
                "type": "string"
              },
              "landing_url": {
                "description": "Dataset page or source URL when the portal gives one.",
                "examples": [
                  "https://www.e-stat.go.jp/stat-search/files?toukei=00200521"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "license": {
                "description": "Licence title or id.",
                "examples": [
                  "CC-BY-4.0"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "name": {
                "description": "Dataset slug.",
                "examples": [
                  "population-census-2020"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "organization": {
                "description": "Publishing organization.",
                "examples": [
                  "総務省"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "portal": {
                "description": "Portal id.",
                "examples": [
                  "data.e-gov.go.jp"
                ],
                "type": "string"
              },
              "region": {
                "description": "Region code.",
                "examples": [
                  "jp"
                ],
                "type": "string"
              },
              "resource_count": {
                "description": "Resources the dataset has in total.",
                "examples": [
                  3
                ],
                "type": "integer"
              },
              "resources": {
                "description": "Up to 25 resources, ready for fetch.raw.",
                "items": {
                  "description": "One downloadable resource.",
                  "properties": {
                    "format": {
                      "description": "CSV, JSON, XLS, HTML...",
                      "examples": [
                        "CSV"
                      ],
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "last_modified": {
                      "description": "Resource modification time.",
                      "examples": [
                        "2026-02-20T00:00:00"
                      ],
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "name": {
                      "description": "Resource name.",
                      "examples": [
                        "人口等基本集計 全国結果"
                      ],
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "size_bytes": {
                      "description": "Size when the portal states it.",
                      "examples": [
                        1048576
                      ],
                      "type": [
                        "integer",
                        "null"
                      ]
                    },
                    "url": {
                      "description": "Download URL.",
                      "examples": [
                        "https://www.e-stat.go.jp/stat-search/file-download?statInfId=000032143614"
                      ],
                      "type": "string"
                    }
                  },
                  "required": [
                    "url"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "tags": {
                "description": "Portal tags.",
                "examples": [
                  [
                    "人口",
                    "国勢調査"
                  ]
                ],
                "items": {
                  "description": "A tag.",
                  "examples": [
                    "人口"
                  ],
                  "type": "string"
                },
                "type": "array"
              },
              "title": {
                "description": "Dataset title, in the portal's language.",
                "examples": [
                  "令和2年国勢調査 人口等基本集計"
                ],
                "type": "string"
              },
              "updated_at": {
                "description": "Portal metadata modification time.",
                "examples": [
                  "2026-03-01T09:12:44.512345"
                ],
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "portal",
              "region",
              "country",
              "id",
              "title",
              "tags",
              "resources",
              "resource_count"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "total_matches": {
          "additionalProperties": {
            "type": "integer"
          },
          "description": "Total matches per portal that answered, keyed by portal id.",
          "examples": [
            {
              "catalog.data.metro.tokyo.lg.jp": 1523,
              "data.e-gov.go.jp": 4699
            }
          ],
          "properties": {},
          "required": [],
          "type": "object"
        }
      },
      "required": [
        "query",
        "region",
        "portals_searched",
        "portals_ok",
        "portals_failed",
        "total_matches",
        "results",
        "result_count",
        "limit_per_portal",
        "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": "opendata.search response",
  "type": "object"
}