Skip to content
Brasil Data Commons Docs

Resolve entities (POST)

POST
/v2/resolve

Resolve external IDs, names, or coordinates to Data Commons DCIDs.

Request Body required

Section titled “Request Body required ”

  1. ID to ID: nodes = [“wikidataId/CA”, “wikidataId/MA”] property = ”<-wikidataId->nutsCode”

  2. Coordinate (latitude#longitude) to DCID: nodes = [“34.56#-23.12”, “-22.11#44.55”] property = ”<-geoCoordinate->dcid”

  3. Description (name) to DCID: nodes = [“Mountain View”, “New York”] property = ”<-description->dcid” or ”<-description{typeOf:City}->dcid”

Three modes are supported:

  1. ID to ID: nodes = [“wikidataId/CA”, “wikidataId/MA”] property = ”<-wikidataId->nutsCode”

  2. Coordinate (latitude#longitude) to DCID: nodes = [“34.56#-23.12”, “-22.11#44.55”] property = ”<-geoCoordinate->dcid”

  3. Description (name) to DCID: nodes = [“Mountain View”, “New York”] property = ”<-description->dcid” or ”<-description{typeOf:City}->dcid”

object
nodes
Array<string>
property
string
resolver

Optional name of a specific custom resolver to use. If not provided, defaults to place resolution using the property param. Supported Values:

  • “indicator”: Resolves Statistical Variables and Topics.
string
target

Optional target for the resolution request. This parameter controls which Data Commons instances are used for resolution. Supported Values:

  • “base_only”: Uses only the base Data Commons instance (remote).
  • “custom_only”: Uses only the custom Data Commons instance (local).
  • “base_and_custom”: Uses both base and custom instances.
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

A successful response.

object
entities
Array<object>
object
node
string
candidates
Array<object>
object
dcid

The DCID of the resolved entity.

string
dominantType

The dominant type of the entity (e.g. “Place”, “StatisticalVariable”).

string
metadata

Auxiliary information describing the match quality or context. Flexible key-value pairs depending on the resolver used.

For resolver=“indicator”:

  • “score”: The cosine similarity score of the match (e.g. “0.98”).
  • “sentence”: The specific description sentence that matched the query.
object
key
additional properties
string
typeOf

All types associated with this entity.

Array<string>

default

Section titled “default ”

An unexpected error response.

object
code
integer format: int32
message
string
details
Array<object>
object
@type
string
key
additional properties