Sign in
Smart Contracts

Get specific data-map inside a contract

Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name].

The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.

In the response, data is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object.

post/v2/map_entry/{contract_address}/{contract_name}/{map_name}

Path parameters

contract_addressstring required

Stacks address

contract_namestring required

Contract name

map_namestring required

Map name

Query parameters

proofinteger

Returns object without the proof field when set to 0

tipstring

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Request body

string required

Response

Success

GetContractDataMapEntrySchemaJson required— unresolved $ref

Changes

Changed in 6 of the 21 revisions of this API.322