Resolve entities

GET

/v2/resolve

• Same-origin path behind the stack Caddy (proxies to the mixer). Used by the in-page Try-it playground.
• Public production endpoint.

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

Parameters

Query Parameters

nodes

Array<string>

property

string

resolver

string

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.

target

string

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.

Responses

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

An unexpected error response.

object

code

integer format: int32

message

string

details

Array<object>

object

@type

string

key

additional properties