Skip to content
Documentation/canton-network-docs/Ledger APIgRPC APIPackagesv2ServicesContractServiceView on canton-network-docs
canton-network-docs/Ledger APIgRPC APIPackagesv2ServicesContractService

GetContract

Ledger APIgRPC APIv2GetContract

com.daml.ledger.api.v2

GetContract

gRPCSince 3.4.11
RPC/com.daml.ledger.api.v2.ContractService/GetContract

Protocol Details

Inputs

GetContractRequest

contract_idstring
querying_partiesrepeated string

Outputs

GetContractResponse

created_eventCreatedEvent

Lifecycle Changes

3.4.11introduced

com.daml.ledger.api.v2.GetContractRequest

contract_idstring
querying_partiesrepeated string

com.daml.ledger.api.v2.GetContractResponse

created_eventCreatedEvent

com.daml.ledger.api.v2.CreatedEvent

offsetint64
node_idint32
contract_idstring
template_idIdentifier
contract_keyValue
contract_key_hashbytes
create_argumentsRecord
created_event_blobbytes
interface_viewsrepeated InterfaceView
witness_partiesrepeated string
signatoriesrepeated string
observersrepeated string
created_atTimestamp
package_namestring
acs_deltabool
representative_package_idstring

com.daml.ledger.api.v2.Identifier

package_idstring
module_namestring
entity_namestring

com.daml.ledger.api.v2.Value

unitEmpty
boolbool
int64sint64
dateint32
timestampsfixed64
numericstring
partystring
textstring
contract_idstring
optionalOptional
listList
text_mapTextMap
gen_mapGenMap
recordRecord
variantVariant
enumEnum

com.daml.ledger.api.v2.Optional

valueValue

com.daml.ledger.api.v2.List

elementsrepeated Value

com.daml.ledger.api.v2.TextMap

entriesrepeated Entry

com.daml.ledger.api.v2.TextMap.Entry

keystring
valueValue

com.daml.ledger.api.v2.GenMap

entriesrepeated Entry

com.daml.ledger.api.v2.GenMap.Entry

keyValue
valueValue

com.daml.ledger.api.v2.Record

record_idIdentifier
fieldsrepeated RecordField

com.daml.ledger.api.v2.RecordField

labelstring
valueValue

com.daml.ledger.api.v2.Variant

variant_idIdentifier
constructorstring
valueValue

com.daml.ledger.api.v2.Enum

enum_idIdentifier
constructorstring

com.daml.ledger.api.v2.InterfaceView

interface_idIdentifier
view_statusStatus
view_valueRecord
implementation_package_idstring
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.ContractService/GetContract <<'EOF'
{
  "contractId": "string",
  "queryingParties": [
    "string"
  ]
}
EOF
OKapplication/json
OK
{
  "createdEvent": {
    "offset": "0",
    "nodeId": 0,
    "contractId": "string",
    "templateId": {
      "packageId": "string",
      "moduleName": "string",
      "entityName": "string"
    },
    "contractKey": {
      "unit": "string"
    },
    "contractKeyHash": "BASE64_ENCODED_BYTES",
    "createArguments": {
      "recordId": {
        "packageId": "string",
        "moduleName": "string",
        "entityName": "string"
      },
      "fields": [
        {
          "label": "string",
          "value": {}
        }
      ]
    },
    "createdEventBlob": "BASE64_ENCODED_BYTES"
  }
}