CCPEDIAby Unity Nodes
Documentation/Canton Network Docs/Ledger APIOpenAPIView on Canton Network Docs ↗

POST /v2/state/active-contracts

POST
/
v2
/
state
/
active-contracts
Try it
cURL
Python
JavaScript
PHP
Go
Java
Ruby
curl --request POST \
  --url 'http://localhost:7575/v2/state/active-contracts' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}'

import json
import requests

url = "http://localhost:7575/v2/state/active-contracts"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}''')
response = requests.request(
    "POST", url, headers=headers, json=payload
)

print(response.text)

const response = await fetch('http://localhost:7575/v2/state/active-contracts', {
  method: 'POST',
  headers: {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}),
});

console.log(await response.text());

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'http://localhost:7575/v2/state/active-contracts',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'JSON'
{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}
JSON,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer <token>",
        "Content-Type: application/json"
    ],
]);

$response = curl_exec($curl);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "http://localhost:7575/v2/state/active-contracts", bytes.NewBufferString(`{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}`))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  response, _ := http.DefaultClient.Do(req)
  defer response.Body.Close()
  body, _ := io.ReadAll(response.Body)
  fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder()
    .uri(URI.create("http://localhost:7575/v2/state/active-contracts"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}
"""))
    .build();
var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'uri'

uri = URI('http://localhost:7575/v2/state/active-contracts')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
  http.request(request)
end
puts response.body
200
400
default
[
  {
    "workflowId": "<string>",
    "contractEntry": {
      "JsActiveContract": {
        "createdEvent": {
          "offset": 123,
          "nodeId": 123,
          "contractId": "<string>",
          "templateId": "<string>",
          "contractKey": "<string>",
          "contractKeyHash": "<string>",
          "createArgument": "<string>",
          "createdEventBlob": "<string>",
          "interfaceViews": [
            "<object>"
          ],
          "witnessParties": [
            "<string>"
          ],
          "signatories": [
            "<string>"
          ],
          "observers": [
            "<string>"
          ],
          "createdAt": "<string>",
          "packageName": "<string>",
          "representativePackageId": "<string>",
          "acsDelta": false
        },
        "synchronizerId": "<string>",
        "reassignmentCounter": 123
      }
    },
    "streamContinuationToken": "<string>"
  }
]

<string>

{
  "code": "<string>",
  "cause": "<string>",
  "correlationId": "<string>",
  "traceId": "<string>",
  "context": {},
  "resources": [
    [
      "<string>"
    ]
  ],
  "errorCategory": 123,
  "grpcCodeValue": 123,
  "retryInfo": "<string>",
  "definiteAnswer": false
}

Query active contracts list (blocking call). Querying active contracts is an expensive operation and if possible should not be repeated often. Consider querying active contracts initially (for a given offset) and then repeatedly call one of /v2/updates/...endpoints to get subsequent modifications. You can also use websockets to get updates with better performance.

OpenAPIUpdated 3.5
cURL
Python
JavaScript
PHP
Go
Java
Ruby
curl --request POST \
  --url 'http://localhost:7575/v2/state/active-contracts' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}'

import json
import requests

url = "http://localhost:7575/v2/state/active-contracts"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}''')
response = requests.request(
    "POST", url, headers=headers, json=payload
)

print(response.text)

const response = await fetch('http://localhost:7575/v2/state/active-contracts', {
  method: 'POST',
  headers: {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}),
});

console.log(await response.text());

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'http://localhost:7575/v2/state/active-contracts',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'JSON'
{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}
JSON,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer <token>",
        "Content-Type: application/json"
    ],
]);

$response = curl_exec($curl);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "http://localhost:7575/v2/state/active-contracts", bytes.NewBufferString(`{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}`))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  response, _ := http.DefaultClient.Do(req)
  defer response.Body.Close()
  body, _ := io.ReadAll(response.Body)
  fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder()
    .uri(URI.create("http://localhost:7575/v2/state/active-contracts"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}
"""))
    .build();
var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'uri'

uri = URI('http://localhost:7575/v2/state/active-contracts')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
  "filter": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    }
  },
  "verbose": false,
  "activeAtOffset": 123,
  "eventFormat": {
    "filtersByParty": {},
    "filtersForAnyParty": {
      "cumulative": [
        {
          "identifierFilter": {
            "Empty": "<object>"
          }
        }
      ]
    },
    "verbose": false
  },
  "streamContinuationToken": "<string>"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
  http.request(request)
end
puts response.body
200
400
default
[
  {
    "workflowId": "<string>",
    "contractEntry": {
      "JsActiveContract": {
        "createdEvent": {
          "offset": 123,
          "nodeId": 123,
          "contractId": "<string>",
          "templateId": "<string>",
          "contractKey": "<string>",
          "contractKeyHash": "<string>",
          "createArgument": "<string>",
          "createdEventBlob": "<string>",
          "interfaceViews": [
            "<object>"
          ],
          "witnessParties": [
            "<string>"
          ],
          "signatories": [
            "<string>"
          ],
          "observers": [
            "<string>"
          ],
          "createdAt": "<string>",
          "packageName": "<string>",
          "representativePackageId": "<string>",
          "acsDelta": false
        },
        "synchronizerId": "<string>",
        "reassignmentCounter": 123
      }
    },
    "streamContinuationToken": "<string>"
  }
]

<string>

{
  "code": "<string>",
  "cause": "<string>",
  "correlationId": "<string>",
  "traceId": "<string>",
  "context": {},
  "resources": [
    [
      "<string>"
    ]
  ],
  "errorCategory": 123,
  "grpcCodeValue": 123,
  "retryInfo": "<string>",
  "definiteAnswer": false
}

​
Authorizations

​
httpAuth

​
Authorization
string
required
HTTP bearer authentication. Send the token as Authorization: Bearer &lt;token&gt;. Ledger API standard JWT token

​
apiKeyAuth

​
Sec-WebSocket-Protocol
string
required
API key authentication in the header. Ledger API standard JWT token (websocket)

​
Query parameters

​
limit
number
OpenAPI type: integer (int64).maximum number of elements to return, this param is ignored if is bigger than server setting
​
stream_idle_timeout_ms
number
OpenAPI type: integer (int64).timeout to complete and send result if no new elements are received (for open ended streams)

​
Body

application/json
​
filter
object
OpenAPI type: TransactionFilter.Provided for backwards compatibility, it will be removed in the Canton version 3.5.0. Used both for filtering create and archive events as well as for filtering transaction trees.

Show child attributes

​
filtersByParty
object
OpenAPI type: Map_Filters.Each key must be a valid PartyIdString (as described in value.proto). The interpretation of the filter depends on the transaction-shape being filtered: 1. For transaction trees (used in GetUpdateTreesResponse for backwards compatibility) all party keys used as wildcard filters, and all subtrees whose root has one of the listed parties as an informee are returned. If there are CumulativeFilters, those will control returned CreatedEvent fields where applicable, but will not be used for template/interface filtering. 2. For ledger-effects create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 3. For transaction and active-contract-set streams create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter.
​
filtersForAnyParty
object
OpenAPI type: Filters.The union of a set of template filters, interface filters, or a wildcard.

Show child attributes

​
cumulative
object[]
OpenAPI type: CumulativeFilter[].Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. If no CumulativeFilter defined, the default of a single WildcardFilter with include_created_event_blob unset is used. Optional: can be empty

Show child attributes

​
identifierFilter
object
OpenAPI type: IdentifierFilter.Required

Show child attributes

​
Variant 1
object

Show child attributes

​
Empty
object
required
OpenAPI type: Empty1.
​
Variant 2
object

Show child attributes

​
InterfaceFilter
object
required
OpenAPI type: InterfaceFilter.This filter matches contracts that implement a specific interface.

Show child attributes

​
value
object
required
OpenAPI type: InterfaceFilter1.This filter matches contracts that implement a specific interface.

Show child attributes

​
interfaceId
string
required
The interface that a matching contract must implement. The interface_id needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
​
includeInterfaceView
boolean
Whether to include the interface view on the contract in the returned CreatedEvent. Use this to access contract data in a uniform manner in your API client. Optional
​
includeCreatedEventBlob
boolean
Whether to include a created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
​
Variant 3
object

Show child attributes

​
TemplateFilter
object
required
OpenAPI type: TemplateFilter.This filter matches contracts of a specific template.

Show child attributes

​
value
object
required
OpenAPI type: TemplateFilter1.This filter matches contracts of a specific template.

Show child attributes

​
templateId
string
required
A template for which the payload should be included in the response. The template_id needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
​
includeCreatedEventBlob
boolean
Whether to include a created_event_blob in the returned CreatedEvent. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
​
Variant 4
object

Show child attributes

​
WildcardFilter
object
required
OpenAPI type: WildcardFilter.This filter matches all templates.

Show child attributes

​
value
object
required
OpenAPI type: WildcardFilter1.This filter matches all templates.

Show child attributes

​
includeCreatedEventBlob
boolean
Whether to include a created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
​
verbose
boolean
Provided for backwards compatibility, it will be removed in the Canton version 3.5.0. If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional, if specified event_format must be unset.
​
activeAtOffset
number
required
OpenAPI type: integer (int64).The offset at which the snapshot of the active contracts will be computed. Must be no greater than the current ledger end offset. Must be greater than or equal to the last pruning offset. Must be a valid absolute offset (positive integer) or ledger begin offset (zero). If zero, the empty set will be returned. Required
​
eventFormat
object
OpenAPI type: EventFormat.A format for events which defines both which events should be included and what data should be computed and included for them. Note that some of the filtering behavior depends on the TransactionShape, which is expected to be specified alongside usages of EventFormat.

Show child attributes

​
filtersByParty
object
OpenAPI type: Map_Filters.Each key must be a valid PartyIdString (as described in value.proto). The interpretation of the filter depends on the transaction-shape being filtered: 1. For ledger-effects create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For transaction and active-contract-set streams create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional: can be empty
​
filtersForAnyParty
object
OpenAPI type: Filters.The union of a set of template filters, interface filters, or a wildcard.

Show child attributes

​
cumulative
object[]
OpenAPI type: CumulativeFilter[].Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. If no CumulativeFilter defined, the default of a single WildcardFilter with include_created_event_blob unset is used. Optional: can be empty

Show child attributes

​
identifierFilter
object
OpenAPI type: IdentifierFilter.Required

Show child attributes

​
Variant 1
object

Show child attributes

​
Empty
object
required
OpenAPI type: Empty1.
​
Variant 2
object

Show child attributes

​
InterfaceFilter
object
required
OpenAPI type: InterfaceFilter.This filter matches contracts that implement a specific interface.

Show child attributes

​
value
object
required
OpenAPI type: InterfaceFilter1.This filter matches contracts that implement a specific interface.

Show child attributes

​
interfaceId
string
required
The interface that a matching contract must implement. The interface_id needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
​
includeInterfaceView
boolean
Whether to include the interface view on the contract in the returned CreatedEvent. Use this to access contract data in a uniform manner in your API client. Optional
​
includeCreatedEventBlob
boolean
Whether to include a created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
​
Variant 3
object

Show child attributes

​
TemplateFilter
object
required
OpenAPI type: TemplateFilter.This filter matches contracts of a specific template.

Show child attributes

​
value
object
required
OpenAPI type: TemplateFilter1.This filter matches contracts of a specific template.

Show child attributes

​
templateId
string
required
A template for which the payload should be included in the response. The template_id needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
​
includeCreatedEventBlob
boolean
Whether to include a created_event_blob in the returned CreatedEvent. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
​
Variant 4
object

Show child attributes

​
WildcardFilter
object
required
OpenAPI type: WildcardFilter.This filter matches all templates.

Show child attributes

​
value
object
required
OpenAPI type: WildcardFilter1.This filter matches all templates.

Show child attributes

​
includeCreatedEventBlob
boolean
Whether to include a created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
​
verbose
boolean
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
​
streamContinuationToken
string
Opaque representation of a continuation token defining a position in the active contracts snapshot. The prefix of the active contracts snapshot will be omitted up to and including the element from which the continuation token was read. To reuse the continuation token from a GetActiveContractsPageResponse: - subsequent request must be executed on the same participant with the same version of canton, - subsequent request must have the same active_at_offset, - subsequent request must have the same event_format - and the participant must not have been pruned after the active_at_offset. If not specified, the whole active contracts snapshot will be returned. Optional: can be empty

​
Responses

​
200

application/json
​
value
JsGetActiveContractsResponse[]
required

Show child attributes

​
workflowId
string
The workflow ID used in command submission which corresponds to the contract_entry. Only set if the workflow_id for the command was set. Must be a valid LedgerString (as described in value.proto). Optional
​
contractEntry
JsContractEntry
For a contract there could be multiple contract_entry-s in the entire snapshot. These together define the state of one contract in the snapshot. A contract_entry is included in the result, if and only if there is at least one stakeholder party of the contract that is hosted on the synchronizer at the time of the event and the party satisfies the TransactionFilter in the query. Required

Show child attributes

​
Variant 1
object

Show child attributes

​
JsActiveContract
JsActiveContract
required

Show child attributes

​
createdEvent
CreatedEvent
required
Records that a contract has been created, and choices may now be exercised on it.

Show child attributes

​
offset
integer (int64)
required
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required
​
nodeId
integer (int32)
required
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required
​
contractId
string
required
The ID of the created contract. Must be a valid LedgerString (as described in value.proto). Required
​
templateId
string
required
The template of the created contract. The identifier uses the package-id reference format. Required
​
contractKey
object
The key of the created contract. This will be set if and only if template_id defines a contract key. Optional
​
contractKeyHash
string
The hash of contract_key. This will be set if and only if template_id defines a contract key. Optional: can be empty
​
createArgument
object
required
The arguments that have been used to create the contract. Required
​
createdEventBlob
string
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional: can be empty
​
interfaceViews
JsInterfaceView[]
Interface views specified in the transaction filter. Includes an InterfaceView for each interface for which there is a InterfaceFilter with - its party in the witness_parties of this event, - and which is implemented by the template of this event, - and which has include_interface_view set. Optional: can be empty

Show child attributes

​
interfaceId
string
required
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
​
viewStatus
JsStatus
required
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required

Show child attributes

​
code
integer (int32)
required
​
message
string
required
​
details
ProtoAny[]

Show child attributes

​
typeUrl
string
required
​
value
string
required
​
unknownFields
UnknownFieldSet
required

Show child attributes

​
fields
Map_Int_Field
required
​
valueDecoded
string
​
viewValue
object
The value of the interface’s view method on this event. Set if it was requested in the InterfaceFilter and it could be successfully computed. Optional
​
implementationPackageId
string
The package defining the interface implementation used to compute the view. Can be different from the package that was used to create the contract itself, as the contract arguments can be upgraded or downgraded using smart-contract upgrading as part of computing the interface view. Populated if the view computation is successful, otherwise empty. Optional
​
witnessParties
string[]
required
The parties that are notified of this event. When a CreatedEvent is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the TransactionFilter that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the TransactionFilter that are stakeholders of the contract (i.e. either signatories or observers). If the CreatedEvent is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the TransactionFilter that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the TopologyEvents for that party by setting a corresponding UpdateFormat. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required: must be non-empty
​
signatories
string[]
required
The signatories for this contract as specified by the template. Required: must be non-empty
​
observers
string[]
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Optional: can be empty
​
createdAt
string
required
Ledger effective time of the transaction that created the contract. Required
​
packageName
string
required
The package name of the created contract. Required
​
representativePackageId
string
required
A package-id present in the participant package store that typechecks the contract’s argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract’s creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
​
acsDelta
boolean
required
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
​
synchronizerId
string
required
A valid synchronizer id Required
​
reassignmentCounter
integer (int64)
required
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. This field will be the reassignment_counter of the latest observable activation event on this synchronizer, which is before the active_at_offset. Required
​
Variant 2
object

Show child attributes

​
JsEmpty
JsEmpty
required
​
Variant 3
object

Show child attributes

​
JsIncompleteAssigned
JsIncompleteAssigned
required

Show child attributes

​
assignedEvent
JsAssignedEvent
required
Records that a contract has been assigned, and it can be used on the target synchronizer.

Show child attributes

​
source
string
required
The ID of the source synchronizer. Must be a valid synchronizer id. Required
​
target
string
required
The ID of the target synchronizer. Must be a valid synchronizer id. Required
​
reassignmentId
string
required
The ID from the unassigned event. For correlation capabilities. Must be a valid LedgerString (as described in value.proto). Required
​
submitter
string
Party on whose behalf the assign command was executed. Empty if the assignment happened offline via the repair service. Must be a valid PartyIdString (as described in value.proto). Optional
​
reassignmentCounter
integer (int64)
required
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
​
createdEvent
CreatedEvent
required
Records that a contract has been created, and choices may now be exercised on it.

Show child attributes

​
offset
integer (int64)
required
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required
​
nodeId
integer (int32)
required
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required
​
contractId
string
required
The ID of the created contract. Must be a valid LedgerString (as described in value.proto). Required
​
templateId
string
required
The template of the created contract. The identifier uses the package-id reference format. Required
​
contractKey
object
The key of the created contract. This will be set if and only if template_id defines a contract key. Optional
​
contractKeyHash
string
The hash of contract_key. This will be set if and only if template_id defines a contract key. Optional: can be empty
​
createArgument
object
required
The arguments that have been used to create the contract. Required
​
createdEventBlob
string
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional: can be empty
​
interfaceViews
JsInterfaceView[]
Interface views specified in the transaction filter. Includes an InterfaceView for each interface for which there is a InterfaceFilter with - its party in the witness_parties of this event, - and which is implemented by the template of this event, - and which has include_interface_view set. Optional: can be empty

Show child attributes

​
interfaceId
string
required
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
​
viewStatus
JsStatus
required
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required

Show child attributes

​
code
integer (int32)
required
​
message
string
required
​
details
ProtoAny[]

Show child attributes

​
typeUrl
string
required
​
value
string
required
​
unknownFields
UnknownFieldSet
required

Show child attributes

​
fields
Map_Int_Field
required
​
valueDecoded
string
​
viewValue
object
The value of the interface’s view method on this event. Set if it was requested in the InterfaceFilter and it could be successfully computed. Optional
​
implementationPackageId
string
The package defining the interface implementation used to compute the view. Can be different from the package that was used to create the contract itself, as the contract arguments can be upgraded or downgraded using smart-contract upgrading as part of computing the interface view. Populated if the view computation is successful, otherwise empty. Optional
​
witnessParties
string[]
required
The parties that are notified of this event. When a CreatedEvent is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the TransactionFilter that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the TransactionFilter that are stakeholders of the contract (i.e. either signatories or observers). If the CreatedEvent is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the TransactionFilter that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the TopologyEvents for that party by setting a corresponding UpdateFormat. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required: must be non-empty
​
signatories
string[]
required
The signatories for this contract as specified by the template. Required: must be non-empty
​
observers
string[]
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Optional: can be empty
​
createdAt
string
required
Ledger effective time of the transaction that created the contract. Required
​
packageName
string
required
The package name of the created contract. Required
​
representativePackageId
string
required
A package-id present in the participant package store that typechecks the contract’s argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract’s creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
​
acsDelta
boolean
required
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
​
Variant 4
object

Show child attributes

​
JsIncompleteUnassigned
JsIncompleteUnassigned
required

Show child attributes

​
createdEvent
CreatedEvent
required
Records that a contract has been created, and choices may now be exercised on it.

Show child attributes

​
offset
integer (int64)
required
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required
​
nodeId
integer (int32)
required
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required
​
contractId
string
required
The ID of the created contract. Must be a valid LedgerString (as described in value.proto). Required
​
templateId
string
required
The template of the created contract. The identifier uses the package-id reference format. Required
​
contractKey
object
The key of the created contract. This will be set if and only if template_id defines a contract key. Optional
​
contractKeyHash
string
The hash of contract_key. This will be set if and only if template_id defines a contract key. Optional: can be empty
​
createArgument
object
required
The arguments that have been used to create the contract. Required
​
createdEventBlob
string
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional: can be empty
​
interfaceViews
JsInterfaceView[]
Interface views specified in the transaction filter. Includes an InterfaceView for each interface for which there is a InterfaceFilter with - its party in the witness_parties of this event, - and which is implemented by the template of this event, - and which has include_interface_view set. Optional: can be empty

Show child attributes

​
interfaceId
string
required
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
​
viewStatus
JsStatus
required
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required

Show child attributes

​
code
integer (int32)
required
​
message
string
required
​
details
ProtoAny[]

Show child attributes

​
typeUrl
string
required
​
value
string
required
​
unknownFields
UnknownFieldSet
required

Show child attributes

​
fields
Map_Int_Field
required
​
valueDecoded
string
​
viewValue
object
The value of the interface’s view method on this event. Set if it was requested in the InterfaceFilter and it could be successfully computed. Optional
​
implementationPackageId
string
The package defining the interface implementation used to compute the view. Can be different from the package that was used to create the contract itself, as the contract arguments can be upgraded or downgraded using smart-contract upgrading as part of computing the interface view. Populated if the view computation is successful, otherwise empty. Optional
​
witnessParties
string[]
required
The parties that are notified of this event. When a CreatedEvent is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the TransactionFilter that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the TransactionFilter that are stakeholders of the contract (i.e. either signatories or observers). If the CreatedEvent is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the TransactionFilter that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the TopologyEvents for that party by setting a corresponding UpdateFormat. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required: must be non-empty
​
signatories
string[]
required
The signatories for this contract as specified by the template. Required: must be non-empty
​
observers
string[]
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Optional: can be empty
​
createdAt
string
required
Ledger effective time of the transaction that created the contract. Required
​
packageName
string
required
The package name of the created contract. Required
​
representativePackageId
string
required
A package-id present in the participant package store that typechecks the contract’s argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract’s creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
​
acsDelta
boolean
required
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
​
unassignedEvent
UnassignedEvent
required
Records that a contract has been unassigned, and it becomes unusable on the source synchronizer

Show child attributes

​
reassignmentId
string
required
The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand. Must be a valid LedgerString (as described in value.proto). Required
​
contractId
string
required
The ID of the reassigned contract. Must be a valid LedgerString (as described in value.proto). Required
​
templateId
string
required
The template of the reassigned contract. The identifier uses the package-id reference format. Required
​
source
string
required
The ID of the source synchronizer Must be a valid synchronizer id Required
​
target
string
required
The ID of the target synchronizer Must be a valid synchronizer id Required
​
submitter
string
Party on whose behalf the unassign command was executed. Empty if the unassignment happened offline via the repair service. Must be a valid PartyIdString (as described in value.proto). Optional
​
reassignmentCounter
integer (int64)
required
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
​
assignmentExclusivity
string
Assignment exclusivity Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment Defined for reassigning participants. Optional
​
witnessParties
string[]
required
The parties that are notified of this event. Required: must be non-empty
​
packageName
string
required
The package name of the contract. Required
​
offset
integer (int64)
required
The offset of origin. Offsets are managed by the participant nodes. Reassignments can thus NOT be assumed to have the same offsets on different participant nodes. Must be a valid absolute offset (positive integer) Required
​
nodeId
integer (int32)
required
The position of this event in the originating reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of reassignments. Must be valid node ID (non-negative integer) Required
​
streamContinuationToken
string
Opaque representation of a continuation token which can be used in the request to bypass the already processed part of the active contracts snapshot. Only populated for the streaming GetActiveContracts rpc call. Optional: can be empty

​
400

Invalid value, Invalid value for: body, Invalid value for: query parameter limit, Invalid value for: query parameter stream_idle_timeout_ms
text/plain
​
value
string
required

​
default

application/json
​
code
string
required
​
cause
string
required
​
correlationId
string
​
traceId
string
​
context
Map_String
required
​
resources
Tuple2_String_String[]
​
errorCategory
integer (int32)
required
​
grpcCodeValue
integer (int32)
​
retryInfo
string
​
definiteAnswer
boolean

​
History

Updated3.5

The POST /v2/state/active-contracts operation changed in this snapshot.