All URIs are relative to https://api.tzkt.io, except if the operation defines another base path.
Method | HTTP request | Description |
---|---|---|
bigMapsGetBigMapById() | GET /v1/bigmaps/{id} | Get bigmap by Id |
bigMapsGetBigMapKeys() | GET /v1/bigmaps/keys | Get bigmap keys |
bigMapsGetBigMapType() | GET /v1/bigmaps/{id}/type | Get bigmap type |
bigMapsGetBigMapUpdates() | GET /v1/bigmaps/updates/count | Get bigmap updates count |
bigMapsGetBigMapUpdates2() | GET /v1/bigmaps/updates | Get bigmap updates |
bigMapsGetBigMaps() | GET /v1/bigmaps | Get bigmaps |
bigMapsGetBigMapsCount() | GET /v1/bigmaps/count | Get bigmaps count |
bigMapsGetHistoricalKeys() | GET /v1/bigmaps/{id}/historical_keys/{level} | Get historical keys |
bigMapsGetKey() | GET /v1/bigmaps/{id}/keys/{key} | Get bigmap key |
bigMapsGetKey2() | GET /v1/bigmaps/{id}/historical_keys/{level}/{key} | Get historical key |
bigMapsGetKeyUpdates() | GET /v1/bigmaps/{id}/keys/{key}/updates | Get bigmap key updates |
bigMapsGetKeys() | GET /v1/bigmaps/{id}/keys | Get bigmap keys |
bigMapsGetBigMapById($id, $micheline): \Bzzhh\Tzkt\Model\BigMap
Get bigmap by Id
Returns a bigmap with the specified Id.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 56; // int | Bigmap Id
$micheline = new \Bzzhh\Tzkt\Model\AccountsGetOperationsMichelineParameter(); // AccountsGetOperationsMichelineParameter | Format of the bigmap key and value type: `0` - JSON, `2` - Micheline
try {
$result = $apiInstance->bigMapsGetBigMapById($id, $micheline);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetBigMapById: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | Bigmap Id | |
micheline | AccountsGetOperationsMichelineParameter | Format of the bigmap key and value type: `0` - JSON, `2` - Micheline | [optional] |
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bigMapsGetBigMapKeys($id, $bigmap, $active, $hash, $key, $value, $first_level, $first_time, $last_level, $last_time, $updates, $sort, $offset, $limit, $select, $micheline): \Bzzhh\Tzkt\Model\BigMapKeyFull[]
Get bigmap keys
Returns a list of all bigmap keys.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id. Click on the parameter to expand more details.
$bigmap = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by bigmap ptr. Click on the parameter to expand more details.
$active = True; // bool | Filters by status: `true` - active, `false` - removed.
$hash = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysHashParameter(); // BigMapsGetBigMapKeysHashParameter | Filter by key hash. Click on the parameter to expand more details.
$key = new \Bzzhh\Tzkt\Model\AccountsGetOperationsParameterParameter(); // AccountsGetOperationsParameterParameter | Filter by key. Note, this parameter supports the following format: `key{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by (for example, `?key.foo.in=bar,baz`). Click on the parameter to expand more details.
$value = new \Bzzhh\Tzkt\Model\AccountsGetOperationsParameterParameter(); // AccountsGetOperationsParameterParameter | Filter by value. Note, this parameter supports the following format: `value{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by (for example, `?value.foo.in=bar,baz`). Click on the parameter to expand more details.
$first_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block where the key was first seen. Click on the parameter to expand more details.
$first_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp (ISO 8601) of the block where the key was first seen. Click on the parameter to expand more details.
$last_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block where the key was last seen. Click on the parameter to expand more details.
$last_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp (ISO 8601) of the block where the key was last seen. Click on the parameter to expand more details.
$updates = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by number of actions with the bigmap key. Click on the parameter to expand more details.
$sort = new \Bzzhh\Tzkt\Model\AccountsGetSortParameter(); // AccountsGetSortParameter | Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below. Click on the parameter to expand more details.
$offset = new \Bzzhh\Tzkt\Model\AccountsGetOffsetParameter(); // AccountsGetOffsetParameter | Specifies which or how many items should be skipped. Click on the parameter to expand more details.
$limit = 56; // int | Maximum number of items to return.
$select = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysSelectParameter(); // BigMapsGetBigMapKeysSelectParameter | Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`). Note, if you select just one field, the response will be flatten into a simple array of values. Click on the parameter to expand the details.
$micheline = new \Bzzhh\Tzkt\Model\AccountsGetOperationsMichelineParameter(); // AccountsGetOperationsMichelineParameter | Format of the `key` and `value` fields: `0` - JSON, `2` - Micheline
try {
$result = $apiInstance->bigMapsGetBigMapKeys($id, $bigmap, $active, $hash, $key, $value, $first_level, $first_time, $last_level, $last_time, $updates, $sort, $offset, $limit, $select, $micheline);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetBigMapKeys: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | AccountsGetIdParameter | Filter by internal TzKT id. Click on the parameter to expand more details. | [optional] |
bigmap | AccountsGetIdParameter | Filter by bigmap ptr. Click on the parameter to expand more details. | [optional] |
active | bool | Filters by status: `true` - active, `false` - removed. | [optional] |
hash | BigMapsGetBigMapKeysHashParameter | Filter by key hash. Click on the parameter to expand more details. | [optional] |
key | AccountsGetOperationsParameterParameter | Filter by key. Note, this parameter supports the following format: `key{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by (for example, `?key.foo.in=bar,baz`). Click on the parameter to expand more details. | [optional] |
value | AccountsGetOperationsParameterParameter | Filter by value. Note, this parameter supports the following format: `value{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by (for example, `?value.foo.in=bar,baz`). Click on the parameter to expand more details. | [optional] |
first_level | AccountsGetIdParameter | Filter by level of the block where the key was first seen. Click on the parameter to expand more details. | [optional] |
first_time | BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp (ISO 8601) of the block where the key was first seen. Click on the parameter to expand more details. | [optional] |
last_level | AccountsGetIdParameter | Filter by level of the block where the key was last seen. Click on the parameter to expand more details. | [optional] |
last_time | BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp (ISO 8601) of the block where the key was last seen. Click on the parameter to expand more details. | [optional] |
updates | AccountsGetIdParameter | Filter by number of actions with the bigmap key. Click on the parameter to expand more details. | [optional] |
sort | AccountsGetSortParameter | Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below. Click on the parameter to expand more details. | [optional] |
offset | AccountsGetOffsetParameter | Specifies which or how many items should be skipped. Click on the parameter to expand more details. | [optional] |
limit | int | Maximum number of items to return. | [optional] |
select | BigMapsGetBigMapKeysSelectParameter | Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`). Note, if you select just one field, the response will be flatten into a simple array of values. Click on the parameter to expand the details. | [optional] |
micheline | AccountsGetOperationsMichelineParameter | Format of the `key` and `value` fields: `0` - JSON, `2` - Micheline | [optional] |
\Bzzhh\Tzkt\Model\BigMapKeyFull[]
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bigMapsGetBigMapType($id): \Bzzhh\Tzkt\Model\MichelinePrim
Get bigmap type
Returns a type of the bigmap with the specified Id in Micheline format (with annotations).
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 56; // int | Bigmap Id
try {
$result = $apiInstance->bigMapsGetBigMapType($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetBigMapType: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | Bigmap Id |
\Bzzhh\Tzkt\Model\MichelinePrim
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bigMapsGetBigMapUpdates($bigmap, $path, $contract, $tags, $action, $value, $level, $timestamp): \Bzzhh\Tzkt\Model\BigMapUpdate[]
Get bigmap updates count
Returns a total number of bigmap updates.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$bigmap = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filters by bigmap ptr
$path = new \Bzzhh\Tzkt\Model\AccountsGetOperationsEntrypointParameter(); // AccountsGetOperationsEntrypointParameter | Filters by bigmap path
$contract = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filters by bigmap contract
$tags = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapsTagsParameter(); // BigMapsGetBigMapsTagsParameter | Filters by bigmap tags: `metadata`, `token_metadata`, `ledger`
$action = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapUpdatesActionParameter(); // BigMapsGetBigMapUpdatesActionParameter | Filters by action
$value = new \Bzzhh\Tzkt\Model\AccountsGetOperationsParameterParameter(); // AccountsGetOperationsParameterParameter | Filters by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`.
$level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filters by level
$timestamp = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filters by timestamp
try {
$result = $apiInstance->bigMapsGetBigMapUpdates($bigmap, $path, $contract, $tags, $action, $value, $level, $timestamp);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetBigMapUpdates: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
bigmap | AccountsGetIdParameter | Filters by bigmap ptr | [optional] |
path | AccountsGetOperationsEntrypointParameter | Filters by bigmap path | [optional] |
contract | AccountsGetDelegateParameter | Filters by bigmap contract | [optional] |
tags | BigMapsGetBigMapsTagsParameter | Filters by bigmap tags: `metadata`, `token_metadata`, `ledger` | [optional] |
action | BigMapsGetBigMapUpdatesActionParameter | Filters by action | [optional] |
value | AccountsGetOperationsParameterParameter | Filters by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`. | [optional] |
level | AccountsGetIdParameter | Filters by level | [optional] |
timestamp | BigMapsGetBigMapKeysFirstTimeParameter | Filters by timestamp | [optional] |
\Bzzhh\Tzkt\Model\BigMapUpdate[]
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bigMapsGetBigMapUpdates2($bigmap, $path, $contract, $tags, $action, $value, $level, $timestamp, $sort, $offset, $limit, $micheline): \Bzzhh\Tzkt\Model\BigMapUpdate[]
Get bigmap updates
Returns a list of all bigmap updates.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$bigmap = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filters by bigmap ptr
$path = new \Bzzhh\Tzkt\Model\AccountsGetOperationsEntrypointParameter(); // AccountsGetOperationsEntrypointParameter | Filters by bigmap path
$contract = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filters by bigmap contract
$tags = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapsTagsParameter(); // BigMapsGetBigMapsTagsParameter | Filters by bigmap tags: `metadata`, `token_metadata`, `ledger`
$action = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapUpdatesActionParameter(); // BigMapsGetBigMapUpdatesActionParameter | Filters by action
$value = new \Bzzhh\Tzkt\Model\AccountsGetOperationsParameterParameter(); // AccountsGetOperationsParameterParameter | Filters by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`.
$level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filters by level
$timestamp = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filters by timestamp
$sort = new \Bzzhh\Tzkt\Model\AccountsGetSortParameter(); // AccountsGetSortParameter | Sorts bigmaps by specified field. Supported fields: `id` (default), `ptr`, `firstLevel`, `lastLevel`, `totalKeys`, `activeKeys`, `updates`.
$offset = new \Bzzhh\Tzkt\Model\AccountsGetOffsetParameter(); // AccountsGetOffsetParameter | Specifies which or how many items should be skipped
$limit = 100; // int | Maximum number of items to return
$micheline = new \Bzzhh\Tzkt\Model\AccountsGetOperationsMichelineParameter(); // AccountsGetOperationsMichelineParameter | Format of the bigmap key and value type: `0` - JSON, `2` - Micheline
try {
$result = $apiInstance->bigMapsGetBigMapUpdates2($bigmap, $path, $contract, $tags, $action, $value, $level, $timestamp, $sort, $offset, $limit, $micheline);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetBigMapUpdates2: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
bigmap | AccountsGetIdParameter | Filters by bigmap ptr | [optional] |
path | AccountsGetOperationsEntrypointParameter | Filters by bigmap path | [optional] |
contract | AccountsGetDelegateParameter | Filters by bigmap contract | [optional] |
tags | BigMapsGetBigMapsTagsParameter | Filters by bigmap tags: `metadata`, `token_metadata`, `ledger` | [optional] |
action | BigMapsGetBigMapUpdatesActionParameter | Filters by action | [optional] |
value | AccountsGetOperationsParameterParameter | Filters by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`. | [optional] |
level | AccountsGetIdParameter | Filters by level | [optional] |
timestamp | BigMapsGetBigMapKeysFirstTimeParameter | Filters by timestamp | [optional] |
sort | AccountsGetSortParameter | Sorts bigmaps by specified field. Supported fields: `id` (default), `ptr`, `firstLevel`, `lastLevel`, `totalKeys`, `activeKeys`, `updates`. | [optional] |
offset | AccountsGetOffsetParameter | Specifies which or how many items should be skipped | [optional] |
limit | int | Maximum number of items to return | [optional] [default to 100] |
micheline | AccountsGetOperationsMichelineParameter | Format of the bigmap key and value type: `0` - JSON, `2` - Micheline | [optional] |
\Bzzhh\Tzkt\Model\BigMapUpdate[]
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bigMapsGetBigMaps($contract, $path, $tags, $active, $last_level, $select, $sort, $offset, $limit, $micheline): \Bzzhh\Tzkt\Model\BigMap[]
Get bigmaps
Returns a list of bigmaps.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$contract = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filters bigmaps by smart contract address.
$path = new \Bzzhh\Tzkt\Model\AccountsGetOperationsEntrypointParameter(); // AccountsGetOperationsEntrypointParameter | Filters bigmaps by path in the contract storage.
$tags = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapsTagsParameter(); // BigMapsGetBigMapsTagsParameter | Filters bigmaps by tags: `metadata`, `token_metadata`, `ledger`.
$active = True; // bool | Filters bigmaps by status: `true` - active, `false` - removed.
$last_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filters bigmaps by the last update level.
$select = new \Bzzhh\Tzkt\Model\AccountsGetSelectParameter(); // AccountsGetSelectParameter | Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.
$sort = new \Bzzhh\Tzkt\Model\AccountsGetSortParameter(); // AccountsGetSortParameter | Sorts bigmaps by specified field. Supported fields: `id` (default), `ptr`, `firstLevel`, `lastLevel`, `totalKeys`, `activeKeys`, `updates`.
$offset = new \Bzzhh\Tzkt\Model\AccountsGetOffsetParameter(); // AccountsGetOffsetParameter | Specifies which or how many items should be skipped
$limit = 100; // int | Maximum number of items to return
$micheline = new \Bzzhh\Tzkt\Model\AccountsGetOperationsMichelineParameter(); // AccountsGetOperationsMichelineParameter | Format of the bigmap key and value type: `0` - JSON, `2` - Micheline
try {
$result = $apiInstance->bigMapsGetBigMaps($contract, $path, $tags, $active, $last_level, $select, $sort, $offset, $limit, $micheline);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetBigMaps: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
contract | AccountsGetDelegateParameter | Filters bigmaps by smart contract address. | [optional] |
path | AccountsGetOperationsEntrypointParameter | Filters bigmaps by path in the contract storage. | [optional] |
tags | BigMapsGetBigMapsTagsParameter | Filters bigmaps by tags: `metadata`, `token_metadata`, `ledger`. | [optional] |
active | bool | Filters bigmaps by status: `true` - active, `false` - removed. | [optional] |
last_level | AccountsGetIdParameter | Filters bigmaps by the last update level. | [optional] |
select | AccountsGetSelectParameter | Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes. | [optional] |
sort | AccountsGetSortParameter | Sorts bigmaps by specified field. Supported fields: `id` (default), `ptr`, `firstLevel`, `lastLevel`, `totalKeys`, `activeKeys`, `updates`. | [optional] |
offset | AccountsGetOffsetParameter | Specifies which or how many items should be skipped | [optional] |
limit | int | Maximum number of items to return | [optional] [default to 100] |
micheline | AccountsGetOperationsMichelineParameter | Format of the bigmap key and value type: `0` - JSON, `2` - Micheline | [optional] |
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bigMapsGetBigMapsCount(): int
Get bigmaps count
Returns the total number of bigmaps.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
try {
$result = $apiInstance->bigMapsGetBigMapsCount();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetBigMapsCount: ', $e->getMessage(), PHP_EOL;
}
This endpoint does not need any parameter.
int
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bigMapsGetHistoricalKeys($id, $level, $active, $key, $value, $select, $sort, $offset, $limit, $micheline): \Bzzhh\Tzkt\Model\BigMapKeyHistorical[]
Get historical keys
Returns a list of bigmap keys at the specific block.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 56; // int | Bigmap Id
$level = 56; // int | Level of the block at which you want to get bigmap keys
$active = True; // bool | Filters keys by status: `true` - active, `false` - removed.
$key = new \Bzzhh\Tzkt\Model\AccountsGetOperationsParameterParameter(); // AccountsGetOperationsParameterParameter | Filters keys by JSON key. Note, this query parameter supports the following format: `?key{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?key.token_id=...`.
$value = new \Bzzhh\Tzkt\Model\AccountsGetOperationsParameterParameter(); // AccountsGetOperationsParameterParameter | Filters keys by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`.
$select = new \Bzzhh\Tzkt\Model\AccountsGetSelectParameter(); // AccountsGetSelectParameter | Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.
$sort = new \Bzzhh\Tzkt\Model\AccountsGetSortParameter(); // AccountsGetSortParameter | Sorts bigmap keys by specified field. Supported fields: `id` (default).
$offset = new \Bzzhh\Tzkt\Model\AccountsGetOffsetParameter(); // AccountsGetOffsetParameter | Specifies which or how many items should be skipped
$limit = 100; // int | Maximum number of items to return
$micheline = new \Bzzhh\Tzkt\Model\AccountsGetOperationsMichelineParameter(); // AccountsGetOperationsMichelineParameter | Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string
try {
$result = $apiInstance->bigMapsGetHistoricalKeys($id, $level, $active, $key, $value, $select, $sort, $offset, $limit, $micheline);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetHistoricalKeys: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | Bigmap Id | |
level | int | Level of the block at which you want to get bigmap keys | |
active | bool | Filters keys by status: `true` - active, `false` - removed. | [optional] |
key | AccountsGetOperationsParameterParameter | Filters keys by JSON key. Note, this query parameter supports the following format: `?key{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?key.token_id=...`. | [optional] |
value | AccountsGetOperationsParameterParameter | Filters keys by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`. | [optional] |
select | AccountsGetSelectParameter | Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes. | [optional] |
sort | AccountsGetSortParameter | Sorts bigmap keys by specified field. Supported fields: `id` (default). | [optional] |
offset | AccountsGetOffsetParameter | Specifies which or how many items should be skipped | [optional] |
limit | int | Maximum number of items to return | [optional] [default to 100] |
micheline | AccountsGetOperationsMichelineParameter | Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string | [optional] |
\Bzzhh\Tzkt\Model\BigMapKeyHistorical[]
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bigMapsGetKey($id, $key, $micheline): \Bzzhh\Tzkt\Model\BigMapKey
Get bigmap key
Returns the specified bigmap key.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 56; // int | Bigmap Id
$key = 'key_example'; // string | Either a key hash (`expr123...`) or a plain value (`foo...`). Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{\"address\":\"tz123\",\"nat\":\"123\"}`.
$micheline = new \Bzzhh\Tzkt\Model\AccountsGetOperationsMichelineParameter(); // AccountsGetOperationsMichelineParameter | Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string
try {
$result = $apiInstance->bigMapsGetKey($id, $key, $micheline);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetKey: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | Bigmap Id | |
key | string | Either a key hash (`expr123...`) or a plain value (`foo...`). Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{"address":"tz123","nat":"123"}`. | |
micheline | AccountsGetOperationsMichelineParameter | Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string | [optional] |
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bigMapsGetKey2($id, $level, $key, $micheline): \Bzzhh\Tzkt\Model\BigMapKeyHistorical
Get historical key
Returns the specified bigmap key at the specific block.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 56; // int | Bigmap Id
$level = 56; // int | Level of the block at which you want to get bigmap key
$key = 'key_example'; // string | Either a key hash (`expr123...`) or a plain value (`foo...`). Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{\"address\":\"tz123\",\"nat\":\"123\"}`.
$micheline = new \Bzzhh\Tzkt\Model\AccountsGetOperationsMichelineParameter(); // AccountsGetOperationsMichelineParameter | Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string
try {
$result = $apiInstance->bigMapsGetKey2($id, $level, $key, $micheline);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetKey2: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | Bigmap Id | |
level | int | Level of the block at which you want to get bigmap key | |
key | string | Either a key hash (`expr123...`) or a plain value (`foo...`). Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{"address":"tz123","nat":"123"}`. | |
micheline | AccountsGetOperationsMichelineParameter | Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string | [optional] |
\Bzzhh\Tzkt\Model\BigMapKeyHistorical
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bigMapsGetKeyUpdates($id, $key, $sort, $offset, $limit, $micheline): \Bzzhh\Tzkt\Model\BigMapKeyUpdate[]
Get bigmap key updates
Returns updates history for the specified bigmap key.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 56; // int | Bigmap Id
$key = 'key_example'; // string | Either a key hash (`expr123...`) or a plain value (`foo...`). Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{\"address\":\"tz123\",\"nat\":\"123\"}`.
$sort = new \Bzzhh\Tzkt\Model\AccountsGetSortParameter(); // AccountsGetSortParameter | Sorts bigmap updates by specified field. Supported fields: `id` (default).
$offset = new \Bzzhh\Tzkt\Model\AccountsGetOffsetParameter(); // AccountsGetOffsetParameter | Specifies which or how many items should be skipped
$limit = 100; // int | Maximum number of items to return
$micheline = new \Bzzhh\Tzkt\Model\AccountsGetOperationsMichelineParameter(); // AccountsGetOperationsMichelineParameter | Format of the key value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string
try {
$result = $apiInstance->bigMapsGetKeyUpdates($id, $key, $sort, $offset, $limit, $micheline);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetKeyUpdates: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | Bigmap Id | |
key | string | Either a key hash (`expr123...`) or a plain value (`foo...`). Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{"address":"tz123","nat":"123"}`. | |
sort | AccountsGetSortParameter | Sorts bigmap updates by specified field. Supported fields: `id` (default). | [optional] |
offset | AccountsGetOffsetParameter | Specifies which or how many items should be skipped | [optional] |
limit | int | Maximum number of items to return | [optional] [default to 100] |
micheline | AccountsGetOperationsMichelineParameter | Format of the key value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string | [optional] |
\Bzzhh\Tzkt\Model\BigMapKeyUpdate[]
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bigMapsGetKeys($id, $active, $key, $value, $last_level, $select, $sort, $offset, $limit, $micheline): \Bzzhh\Tzkt\Model\BigMapKey[]
Get bigmap keys
Returns a list of bigmap keys.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Bzzhh\Tzkt\Api\BigMapsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 56; // int | Bigmap Id
$active = True; // bool | Filters keys by status: `true` - active, `false` - removed.
$key = new \Bzzhh\Tzkt\Model\AccountsGetOperationsParameterParameter(); // AccountsGetOperationsParameterParameter | Filters keys by JSON key. Note, this query parameter supports the following format: `?key{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?key.token_id=...`.
$value = new \Bzzhh\Tzkt\Model\AccountsGetOperationsParameterParameter(); // AccountsGetOperationsParameterParameter | Filters keys by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`.
$last_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filters bigmap keys by the last update level.
$select = new \Bzzhh\Tzkt\Model\AccountsGetSelectParameter(); // AccountsGetSelectParameter | Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.
$sort = new \Bzzhh\Tzkt\Model\AccountsGetSortParameter(); // AccountsGetSortParameter | Sorts bigmap keys by specified field. Supported fields: `id` (default), `firstLevel`, `lastLevel`, `updates`.
$offset = new \Bzzhh\Tzkt\Model\AccountsGetOffsetParameter(); // AccountsGetOffsetParameter | Specifies which or how many items should be skipped
$limit = 100; // int | Maximum number of items to return
$micheline = new \Bzzhh\Tzkt\Model\AccountsGetOperationsMichelineParameter(); // AccountsGetOperationsMichelineParameter | Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string
try {
$result = $apiInstance->bigMapsGetKeys($id, $active, $key, $value, $last_level, $select, $sort, $offset, $limit, $micheline);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BigMapsApi->bigMapsGetKeys: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | Bigmap Id | |
active | bool | Filters keys by status: `true` - active, `false` - removed. | [optional] |
key | AccountsGetOperationsParameterParameter | Filters keys by JSON key. Note, this query parameter supports the following format: `?key{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?key.token_id=...`. | [optional] |
value | AccountsGetOperationsParameterParameter | Filters keys by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`. | [optional] |
last_level | AccountsGetIdParameter | Filters bigmap keys by the last update level. | [optional] |
select | AccountsGetSelectParameter | Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes. | [optional] |
sort | AccountsGetSortParameter | Sorts bigmap keys by specified field. Supported fields: `id` (default), `firstLevel`, `lastLevel`, `updates`. | [optional] |
offset | AccountsGetOffsetParameter | Specifies which or how many items should be skipped | [optional] |
limit | int | Maximum number of items to return | [optional] [default to 100] |
micheline | AccountsGetOperationsMichelineParameter | Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string | [optional] |
No authorization required
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]