Skip to content
Brasil Data Commons Docs

Overview

Brasil Data Commons API (v1+v2)

Section titled “Brasil Data Commons API (v1+v2)”

REST/JSON interface to the Brasil Data Commons knowledge graph, served by the mixer.

This reference is generated from the mixer’s OpenAPI spec. Regenerate app/docs/src/openapi/mixer.openapi.json with npm run gen:openapi after changing app/mixer/proto/service/mixer.proto.

Available endpoints

  • GET /v2/event - Query events
  • POST /v2/event - Query events (POST)
  • GET /v2/node - Query graph nodes
  • POST /v2/node - Query graph nodes (POST)
  • GET /v2/resolve - Resolve entities
  • POST /v2/resolve - Resolve entities (POST)
  • GET /v2/observation - Query observations
  • POST /v2/observation - Query observations (POST)
  • GET /v1/bulk/info/variable - Bulk variable info
  • POST /v1/bulk/info/variable - Bulk variable info (POST)
  • GET /v1/bulk/info/variable-group - Bulk variable group info
  • POST /v1/bulk/info/variable-group - Bulk variable group info (POST)
  • POST /v1/variable/ancestors - Variable ancestors (POST)
  • GET /v1/variable/ancestors/{node} - Variable ancestors
  • GET /v1/variable/search - Search statistical variables
  • POST /v1/variable/search - Search statistical variables (POST)
  • GET /v1/recognize/entities - Recognize entities
  • POST /v1/recognize/entities - Recognize entities (POST)
  • GET /v1/recognize/places - Recognize places
  • POST /v1/recognize/places - Recognize places (POST)
  • GET /version - Server version
  • OpenAPI version: 3.0.0