POST /v0/history/bulk/updates

Under Development, do not use in production yet Get download URLs and metadata for update history objects available for bulk download, between two record times. Note that the returned objects may include also updates outside of the requested record time range (since only full objects are served from storage), but guaranteed to include all updates in the requested range.

POST /v0/history/bulk/updates

POST /v0/history/bulk/updates

cURL

curl --request POST \
  --url https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/history/bulk/updates \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_record_time": "2023-11-07T05:31:56Z",
  "end_record_time": "2023-11-07T05:31:56Z",
  "page_size": 500,
  "next_page_token": "<string>"
}
'

import requests

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

payload = {
    "start_record_time": "2023-11-07T05:31:56Z",
    "end_record_time": "2023-11-07T05:31:56Z",
    "page_size": 500,
    "next_page_token": "<string>"
}
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({
    start_record_time: '2023-11-07T05:31:56Z',
    end_record_time: '2023-11-07T05:31:56Z',
    page_size: 500,
    next_page_token: '<string>'
  })
};

fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/history/bulk/updates', 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/history/bulk/updates",
  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([
    'start_record_time' => '2023-11-07T05:31:56Z',
    'end_record_time' => '2023-11-07T05:31:56Z',
    'page_size' => 500,
    'next_page_token' => '<string>'
  ]),
  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/history/bulk/updates"

	payload := strings.NewReader("{\n  \"start_record_time\": \"2023-11-07T05:31:56Z\",\n  \"end_record_time\": \"2023-11-07T05:31:56Z\",\n  \"page_size\": 500,\n  \"next_page_token\": \"<string>\"\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/history/bulk/updates")
  .header("Content-Type", "application/json")
  .body("{\n  \"start_record_time\": \"2023-11-07T05:31:56Z\",\n  \"end_record_time\": \"2023-11-07T05:31:56Z\",\n  \"page_size\": 500,\n  \"next_page_token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"start_record_time\": \"2023-11-07T05:31:56Z\",\n  \"end_record_time\": \"2023-11-07T05:31:56Z\",\n  \"page_size\": 500,\n  \"next_page_token\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "object_refs": [
    {
      "url": "<string>",
      "digest": "<string>"
    }
  ],
  "next_page_token": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Body

application/json

start_record_time · string<date-time> · required

The returned objects must include all updates with record time greater than start_record_time (but may also include updates before it).

end_record_time · string<date-time> · required

The returned objects must include all updates with record time at most end_record_time (but may also include updates after it).

page_size · integer<int32> · required

The maximum number of objects returned for this request.

Required range: 1 <= x <= 1000

next_page_token · string

The pagination token returned from a previous call to this endpoint with the same arguments.

Response

200

application/json

ok

object_refs · object[] · required

The list of references to the bulk storage objects containing the updates.

Show child attributes

next_page_token · string

When requesting the next page of results, pass this as after to the next ListBulkUpdateHistoryObjectsRequest invocation. Will be absent when there are no more pages.