Skip to content
Documentation/canton-network-docs/Splice APIsScan APIsScan APIView on canton-network-docs
canton-network-docs/Splice APIsScan APIsScan API

POST /v0/backfilling/updates

POST
/
v0
/
backfilling
/
updates-before
Try it
POST /v0/backfilling/updates-before

cURL

curl --request POST \
  --url https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/backfilling/updates-before \
  --header 'Content-Type: application/json' \
  --data '
{
  "migration_id": 123,
  "synchronizer_id": "<string>",
  "before": "2023-11-07T05:31:56Z",
  "count": 123,
  "at_or_after": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/backfilling/updates-before"

payload = {
    "migration_id": 123,
    "synchronizer_id": "<string>",
    "before": "2023-11-07T05:31:56Z",
    "count": 123,
    "at_or_after": "2023-11-07T05:31:56Z"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    migration_id: 123,
    synchronizer_id: '<string>',
    before: '2023-11-07T05:31:56Z',
    count: 123,
    at_or_after: '2023-11-07T05:31:56Z'
  })
};

fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/backfilling/updates-before', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/backfilling/updates-before",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'migration_id' => 123,
    'synchronizer_id' => '<string>',
    'before' => '2023-11-07T05:31:56Z',
    'count' => 123,
    'at_or_after' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/backfilling/updates-before"

	payload := strings.NewReader("{\n  \"migration_id\": 123,\n  \"synchronizer_id\": \"<string>\",\n  \"before\": \"2023-11-07T05:31:56Z\",\n  \"count\": 123,\n  \"at_or_after\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/backfilling/updates-before")
  .header("Content-Type", "application/json")
  .body("{\n  \"migration_id\": 123,\n  \"synchronizer_id\": \"<string>\",\n  \"before\": \"2023-11-07T05:31:56Z\",\n  \"count\": 123,\n  \"at_or_after\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/backfilling/updates-before")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"migration_id\": 123,\n  \"synchronizer_id\": \"<string>\",\n  \"before\": \"2023-11-07T05:31:56Z\",\n  \"count\": 123,\n  \"at_or_after\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
200
404
{
  "transactions": [
    {
      "update_id": "<string>",
      "migration_id": 123,
      "workflow_id": "<string>",
      "record_time": "<string>",
      "synchronizer_id": "<string>",
      "effective_at": "<string>",
      "offset": "<string>",
      "root_event_ids": [
        "<string>"
      ],
      "events_by_id": {},
      "external_transaction_hash": "<string>"
    }
  ]
}
{
  "error": "<string>"
}

Body

application/json
migration_id
integer<int64>
required
synchronizer_id
string
required
before
string<date-time>
required

Only return updates with a record time strictly smaller than this time.

count
integer<int32>
required

Return at most this many updates. The actual number of updates returned may be smaller.

at_or_after
string<date-time>

Only return updates with a record time equal to or greater than this time.

Response

200
application/json

ok

transactions
object[]
required

An individual item in the update history. May be a transaction or a contract reassignment.

  • Option 1
  • Option 2

Show child attributes