Bzzhh\Tzkt\ContractsApi

All URIs are relative to https://api.tzkt.io, except if the operation defines another base path.

Method	HTTP request	Description
contractsBuildEntrypointParametersGET()	GET /v1/contracts/{address}/entrypoints/{name}/build	Build entrypoint parameters
contractsBuildEntrypointParametersPOST()	POST /v1/contracts/{address}/entrypoints/{name}/build	Build entrypoint parameters
contractsGet()	GET /v1/contracts	Get contracts
contractsGetBigMapByName()	GET /v1/contracts/{address}/bigmaps/{name}	Get bigmap by name
contractsGetBigMapByNameKeys()	GET /v1/contracts/{address}/bigmaps/{name}/keys	Get bigmap keys
contractsGetBigMaps()	GET /v1/contracts/{address}/bigmaps	Get contract bigmaps
contractsGetByAddress()	GET /v1/contracts/{address}	Get contract by address
contractsGetCode()	GET /v1/contracts/{address}/code	Get contract code
contractsGetContractViewByName()	GET /v1/contracts/{address}/views/{name}	Get view by name
contractsGetContractViews()	GET /v1/contracts/{address}/views	Get contract views
contractsGetCount()	GET /v1/contracts/count	Get contracts count
contractsGetEntrypointByName()	GET /v1/contracts/{address}/entrypoints/{name}	Get entrypoint by name
contractsGetEntrypoints()	GET /v1/contracts/{address}/entrypoints	Get contract entrypoints
contractsGetHistoricalKeys()	GET /v1/contracts/{address}/bigmaps/{name}/historical_keys/{level}	Get historical keys
contractsGetInterface()	GET /v1/contracts/{address}/interface	Get JSON Schema [2020-12] interface for the contract
contractsGetKey()	GET /v1/contracts/{address}/bigmaps/{name}/keys/{key}	Get bigmap key
contractsGetKey2()	GET /v1/contracts/{address}/bigmaps/{name}/historical_keys/{level}/{key}	Get historical key
contractsGetKeyUpdates()	GET /v1/contracts/{address}/bigmaps/{name}/keys/{key}/updates	Get bigmap key updates
contractsGetRawStorage()	GET /v1/contracts/{address}/storage/raw	Get raw contract storage
contractsGetRawStorageHistory()	GET /v1/contracts/{address}/storage/raw/history	Get raw contract storage history
contractsGetRawStorageSchema()	GET /v1/contracts/{address}/storage/raw/schema	Get raw contract storage schema
contractsGetSame()	GET /v1/contracts/{address}/same	Get same contracts
contractsGetSimilar()	GET /v1/contracts/{address}/similar	Get similar contracts
contractsGetStorage()	GET /v1/contracts/{address}/storage	Get contract storage
contractsGetStorageHistory()	GET /v1/contracts/{address}/storage/history	Get contract storage history
contractsGetStorageSchema()	GET /v1/contracts/{address}/storage/schema	Get contract storage schema

`contractsBuildEntrypointParametersGET()`

contractsBuildEntrypointParametersGET($address, $name, $value): \SplFileObject

Build entrypoint parameters

Returns micheline parameters converted from its JSON representation.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$name = 'name_example'; // string | Entrypoint name
$value = 'value_example'; // string | Json parameters

try {
    $result = $apiInstance->contractsBuildEntrypointParametersGET($address, $name, $value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsBuildEntrypointParametersGET: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
name	string	Entrypoint name
value	string	Json parameters	[optional]

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsBuildEntrypointParametersPOST()`

contractsBuildEntrypointParametersPOST($address, $name, $body): \SplFileObject

Build entrypoint parameters

Returns micheline parameters converted from its JSON representation.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$name = 'name_example'; // string | Entrypoint name
$body = NULL; // mixed | Json parameters

try {
    $result = $apiInstance->contractsBuildEntrypointParametersPOST($address, $name, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsBuildEntrypointParametersPOST: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
address	string	Contract address
name	string	Entrypoint name
body	mixed	Json parameters

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGet()`

contractsGet($id, $address, $kind, $tzips, $balance, $creator, $manager, $delegate, $first_activity, $first_activity_time, $last_activity, $last_activity_time, $type_hash, $code_hash, $sort, $offset, $limit, $select, $include_storage): \Bzzhh\Tzkt\Model\Contract[]

Get contracts

Returns a list of contract accounts.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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\AccountsGetBalanceParameter(); // AccountsGetBalanceParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$address = new \Bzzhh\Tzkt\Model\AccountsGetAddressParameter(); // AccountsGetAddressParameter | Filter by address.   Click on the parameter to expand more details.
$kind = new \Bzzhh\Tzkt\Model\AccountsGetKindParameter(); // AccountsGetKindParameter | Filter by kind (`delegator_contract`, `smart_contract`, or `asset`).   Click on the parameter to expand more details.
$tzips = new \Bzzhh\Tzkt\Model\ContractsGetTzipsParameter(); // ContractsGetTzipsParameter | Filter by tzips (`fa1`, `fa12`, or `fa2`).   Click on the parameter to expand more details.
$balance = new \Bzzhh\Tzkt\Model\AccountsGetBalanceParameter(); // AccountsGetBalanceParameter | Filter by balance.   Click on the parameter to expand more details.
$creator = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by creator.   Click on the parameter to expand more details.
$manager = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by manager.   Click on the parameter to expand more details.
$delegate = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by delegate.   Click on the parameter to expand more details.
$first_activity = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block where the contract was first seen.   Click on the parameter to expand more details.
$first_activity_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp (ISO 8601) of the block where the contract was first seen.   Click on the parameter to expand more details.
$last_activity = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block where the contract was last seen.   Click on the parameter to expand more details.
$last_activity_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp (ISO 8601) of the block where the contract was last seen.   Click on the parameter to expand more details.
$type_hash = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by 32-bit hash of contract parameter and storage types (helpful for searching similar contracts).   Click on the parameter to expand more details.
$code_hash = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by 32-bit hash of contract code (helpful for searching same contracts).   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.
$include_storage = false; // bool | Specifies whether to include contract storage into response.

try {
    $result = $apiInstance->contractsGet($id, $address, $kind, $tzips, $balance, $creator, $manager, $delegate, $first_activity, $first_activity_time, $last_activity, $last_activity_time, $type_hash, $code_hash, $sort, $offset, $limit, $select, $include_storage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	AccountsGetBalanceParameter	Filter by internal TzKT id. Click on the parameter to expand more details.	[optional]
address	AccountsGetAddressParameter	Filter by address. Click on the parameter to expand more details.	[optional]
kind	AccountsGetKindParameter	Filter by kind (`delegator_contract`, `smart_contract`, or `asset`). Click on the parameter to expand more details.	[optional]
tzips	ContractsGetTzipsParameter	Filter by tzips (`fa1`, `fa12`, or `fa2`). Click on the parameter to expand more details.	[optional]
balance	AccountsGetBalanceParameter	Filter by balance. Click on the parameter to expand more details.	[optional]
creator	AccountsGetDelegateParameter	Filter by creator. Click on the parameter to expand more details.	[optional]
manager	AccountsGetDelegateParameter	Filter by manager. Click on the parameter to expand more details.	[optional]
delegate	AccountsGetDelegateParameter	Filter by delegate. Click on the parameter to expand more details.	[optional]
first_activity	AccountsGetIdParameter	Filter by level of the block where the contract was first seen. Click on the parameter to expand more details.	[optional]
first_activity_time	BigMapsGetBigMapKeysFirstTimeParameter	Filter by timestamp (ISO 8601) of the block where the contract was first seen. Click on the parameter to expand more details.	[optional]
last_activity	AccountsGetIdParameter	Filter by level of the block where the contract was last seen. Click on the parameter to expand more details.	[optional]
last_activity_time	BigMapsGetBigMapKeysFirstTimeParameter	Filter by timestamp (ISO 8601) of the block where the contract was last seen. Click on the parameter to expand more details.	[optional]
type_hash	AccountsGetIdParameter	Filter by 32-bit hash of contract parameter and storage types (helpful for searching similar contracts). Click on the parameter to expand more details.	[optional]
code_hash	AccountsGetIdParameter	Filter by 32-bit hash of contract code (helpful for searching same contracts). 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]
include_storage	bool	Specifies whether to include contract storage into response.	[optional] [default to false]

Return type

\Bzzhh\Tzkt\Model\Contract[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetBigMapByName()`

contractsGetBigMapByName($address, $name, $micheline): \Bzzhh\Tzkt\Model\BigMap

Get bigmap by name

Returns contract bigmap with the specified name or storage path.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$name = 'name_example'; // string | Bigmap name is the last piece of the bigmap storage path.             For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.             If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
$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->contractsGetBigMapByName($address, $name, $micheline);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetBigMapByName: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
name	string	Bigmap name is the last piece of the bigmap storage path. For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`. If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
micheline	AccountsGetOperationsMichelineParameter	Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string	[optional]

Return type

\Bzzhh\Tzkt\Model\BigMap

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetBigMapByNameKeys()`

contractsGetBigMapByNameKeys($address, $name, $active, $key, $value, $last_level, $select, $sort, $offset, $limit, $micheline): \Bzzhh\Tzkt\Model\BigMapKey[]

Get bigmap keys

Returns keys of a contract bigmap with the specified name.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$name = 'name_example'; // string | Bigmap name is the last piece of the bigmap storage path.             For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.             If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
$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->contractsGetBigMapByNameKeys($address, $name, $active, $key, $value, $last_level, $select, $sort, $offset, $limit, $micheline);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetBigMapByNameKeys: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
name	string	Bigmap name is the last piece of the bigmap storage path. For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`. If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
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]

Return type

\Bzzhh\Tzkt\Model\BigMapKey[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetBigMaps()`

contractsGetBigMaps($address, $tags, $select, $sort, $offset, $limit, $micheline): \Bzzhh\Tzkt\Model\BigMap[]

Get contract bigmaps

Returns all active bigmaps allocated in the contract storage.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$tags = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapsTagsParameter(); // BigMapsGetBigMapsTagsParameter | Filters bigmaps tags (`metadata`, `token_metadata`, `ledger`).
$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), `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: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string

try {
    $result = $apiInstance->contractsGetBigMaps($address, $tags, $select, $sort, $offset, $limit, $micheline);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetBigMaps: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
tags	BigMapsGetBigMapsTagsParameter	Filters bigmaps tags (`metadata`, `token_metadata`, `ledger`).	[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), `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: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string	[optional]

Return type

\Bzzhh\Tzkt\Model\BigMap[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetByAddress()`

contractsGetByAddress($address, $legacy): \Bzzhh\Tzkt\Model\Contract

Get contract by address

Returns a contract account with the specified address.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address (starting with KT)
$legacy = true; // bool | If `true` (by default), the `metadata` field will contain tzkt profile info, or TZIP-16 metadata otherwise. This is a part of a deprecation mechanism, allowing to switch to new functionality smoothly.

try {
    $result = $apiInstance->contractsGetByAddress($address, $legacy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetByAddress: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address (starting with KT)
legacy	bool	If `true` (by default), the `metadata` field will contain tzkt profile info, or TZIP-16 metadata otherwise. This is a part of a deprecation mechanism, allowing to switch to new functionality smoothly.	[optional] [default to true]

Return type

\Bzzhh\Tzkt\Model\Contract

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetCode()`

contractsGetCode($address, $level, $format): \SplFileObject

Get contract code

Returns a code of the specified contract.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address (starting with KT)
$level = 0; // int | Level at which contract code should be taken. If `0` or not specified, the current value will be returned.
$format = 0; // int | Code format (`0` - micheline, `1` - michelson, `2` - bytes (base64))

try {
    $result = $apiInstance->contractsGetCode($address, $level, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetCode: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address (starting with KT)
level	int	Level at which contract code should be taken. If `0` or not specified, the current value will be returned.	[optional] [default to 0]
format	int	Code format (`0` - micheline, `1` - michelson, `2` - bytes (base64))	[optional] [default to 0]

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetContractViewByName()`

contractsGetContractViewByName($address, $name, $json, $micheline, $michelson): \Bzzhh\Tzkt\Model\ContractView

Get view by name

Returns contract view with specified name.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address (starting with KT)
$name = 'name_example'; // string | View name
$json = true; // bool | Include parameter and return types in human-readable JSON format
$micheline = false; // bool | Include parameter and return types in micheline format
$michelson = false; // bool | Include parameter and return types in michelson format

try {
    $result = $apiInstance->contractsGetContractViewByName($address, $name, $json, $micheline, $michelson);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetContractViewByName: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address (starting with KT)
name	string	View name
json	bool	Include parameter and return types in human-readable JSON format	[optional] [default to true]
micheline	bool	Include parameter and return types in micheline format	[optional] [default to false]
michelson	bool	Include parameter and return types in michelson format	[optional] [default to false]

Return type

\Bzzhh\Tzkt\Model\ContractView

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetContractViews()`

contractsGetContractViews($address, $json, $micheline, $michelson): \Bzzhh\Tzkt\Model\ContractView[]

Get contract views

Returns all views of the specified contract.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address (starting with KT)
$json = true; // bool | Include parameter and return types in human-readable JSON format
$micheline = false; // bool | Include parameter and return types in micheline format
$michelson = false; // bool | Include parameter and return types in michelson format

try {
    $result = $apiInstance->contractsGetContractViews($address, $json, $micheline, $michelson);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetContractViews: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address (starting with KT)
json	bool	Include parameter and return types in human-readable JSON format	[optional] [default to true]
micheline	bool	Include parameter and return types in micheline format	[optional] [default to false]
michelson	bool	Include parameter and return types in michelson format	[optional] [default to false]

Return type

\Bzzhh\Tzkt\Model\ContractView[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetCount()`

contractsGetCount($id, $address, $kind, $tzips, $balance, $creator, $manager, $delegate, $first_activity, $first_activity_time, $last_activity, $last_activity_time, $type_hash, $code_hash): int

Get contracts count

Returns a number of contract accounts.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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\AccountsGetBalanceParameter(); // AccountsGetBalanceParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$address = new \Bzzhh\Tzkt\Model\AccountsGetAddressParameter(); // AccountsGetAddressParameter | Filter by address.   Click on the parameter to expand more details.
$kind = new \Bzzhh\Tzkt\Model\AccountsGetKindParameter(); // AccountsGetKindParameter | Filter by kind (`delegator_contract`, `smart_contract`, or `asset`).   Click on the parameter to expand more details.
$tzips = new \Bzzhh\Tzkt\Model\ContractsGetTzipsParameter(); // ContractsGetTzipsParameter | Filter by tzips (`fa1`, `fa12`, or `fa2`).   Click on the parameter to expand more details.
$balance = new \Bzzhh\Tzkt\Model\AccountsGetBalanceParameter(); // AccountsGetBalanceParameter | Filter by balance.   Click on the parameter to expand more details.
$creator = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by creator.   Click on the parameter to expand more details.
$manager = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by manager.   Click on the parameter to expand more details.
$delegate = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by delegate.   Click on the parameter to expand more details.
$first_activity = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block where the contract was first seen.   Click on the parameter to expand more details.
$first_activity_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp (ISO 8601) of the block where the contract was first seen.   Click on the parameter to expand more details.
$last_activity = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block where the contract was last seen.   Click on the parameter to expand more details.
$last_activity_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp (ISO 8601) of the block where the contract was last seen.   Click on the parameter to expand more details.
$type_hash = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by 32-bit hash of contract parameter and storage types (helpful for searching similar contracts).   Click on the parameter to expand more details.
$code_hash = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by 32-bit hash of contract code (helpful for searching same contracts).   Click on the parameter to expand more details.

try {
    $result = $apiInstance->contractsGetCount($id, $address, $kind, $tzips, $balance, $creator, $manager, $delegate, $first_activity, $first_activity_time, $last_activity, $last_activity_time, $type_hash, $code_hash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	AccountsGetBalanceParameter	Filter by internal TzKT id. Click on the parameter to expand more details.	[optional]
address	AccountsGetAddressParameter	Filter by address. Click on the parameter to expand more details.	[optional]
kind	AccountsGetKindParameter	Filter by kind (`delegator_contract`, `smart_contract`, or `asset`). Click on the parameter to expand more details.	[optional]
tzips	ContractsGetTzipsParameter	Filter by tzips (`fa1`, `fa12`, or `fa2`). Click on the parameter to expand more details.	[optional]
balance	AccountsGetBalanceParameter	Filter by balance. Click on the parameter to expand more details.	[optional]
creator	AccountsGetDelegateParameter	Filter by creator. Click on the parameter to expand more details.	[optional]
manager	AccountsGetDelegateParameter	Filter by manager. Click on the parameter to expand more details.	[optional]
delegate	AccountsGetDelegateParameter	Filter by delegate. Click on the parameter to expand more details.	[optional]
first_activity	AccountsGetIdParameter	Filter by level of the block where the contract was first seen. Click on the parameter to expand more details.	[optional]
first_activity_time	BigMapsGetBigMapKeysFirstTimeParameter	Filter by timestamp (ISO 8601) of the block where the contract was first seen. Click on the parameter to expand more details.	[optional]
last_activity	AccountsGetIdParameter	Filter by level of the block where the contract was last seen. Click on the parameter to expand more details.	[optional]
last_activity_time	BigMapsGetBigMapKeysFirstTimeParameter	Filter by timestamp (ISO 8601) of the block where the contract was last seen. Click on the parameter to expand more details.	[optional]
type_hash	AccountsGetIdParameter	Filter by 32-bit hash of contract parameter and storage types (helpful for searching similar contracts). Click on the parameter to expand more details.	[optional]
code_hash	AccountsGetIdParameter	Filter by 32-bit hash of contract code (helpful for searching same contracts). Click on the parameter to expand more details.	[optional]

Return type

int

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetEntrypointByName()`

contractsGetEntrypointByName($address, $name, $json, $micheline, $michelson): \Bzzhh\Tzkt\Model\Entrypoint

Get entrypoint by name

Returns contract's entrypoint with specified name.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address (starting with KT)
$name = 'name_example'; // string | Entrypoint name
$json = true; // bool | Include parameters schema in human-readable JSON format
$micheline = false; // bool | Include parameters schema in micheline format
$michelson = false; // bool | Include parameters schema in michelson format

try {
    $result = $apiInstance->contractsGetEntrypointByName($address, $name, $json, $micheline, $michelson);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetEntrypointByName: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address (starting with KT)
name	string	Entrypoint name
json	bool	Include parameters schema in human-readable JSON format	[optional] [default to true]
micheline	bool	Include parameters schema in micheline format	[optional] [default to false]
michelson	bool	Include parameters schema in michelson format	[optional] [default to false]

Return type

\Bzzhh\Tzkt\Model\Entrypoint

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetEntrypoints()`

contractsGetEntrypoints($address, $all, $json, $micheline, $michelson): \Bzzhh\Tzkt\Model\Entrypoint[]

Get contract entrypoints

Returns entrypoints of the specified contract.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address (starting with KT)
$all = false; // bool | If true, returns all entrypoints, including unused ones.             Unused means that the entrypoint can be normalized to a more specific one.             For example here `(or %entry1 (unit %entry2) (nat %entry3))` the `%entry1` is unused entrypoint             because it can be normalized to `%entry2` or `%entry3`
$json = true; // bool | Include parameters schema in human-readable JSON format
$micheline = false; // bool | Include parameters schema in micheline format
$michelson = false; // bool | Include parameters schema in michelson format

try {
    $result = $apiInstance->contractsGetEntrypoints($address, $all, $json, $micheline, $michelson);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetEntrypoints: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address (starting with KT)
all	bool	If true, returns all entrypoints, including unused ones. Unused means that the entrypoint can be normalized to a more specific one. For example here `(or %entry1 (unit %entry2) (nat %entry3))` the `%entry1` is unused entrypoint because it can be normalized to `%entry2` or `%entry3`	[optional] [default to false]
json	bool	Include parameters schema in human-readable JSON format	[optional] [default to true]
micheline	bool	Include parameters schema in micheline format	[optional] [default to false]
michelson	bool	Include parameters schema in michelson format	[optional] [default to false]

Return type

\Bzzhh\Tzkt\Model\Entrypoint[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetHistoricalKeys()`

contractsGetHistoricalKeys($address, $name, $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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$name = 'name_example'; // string | Bigmap name is the last piece of the bigmap storage path.             For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.             If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
$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->contractsGetHistoricalKeys($address, $name, $level, $active, $key, $value, $select, $sort, $offset, $limit, $micheline);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetHistoricalKeys: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
name	string	Bigmap name is the last piece of the bigmap storage path. For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`. If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
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]

Return type

\Bzzhh\Tzkt\Model\BigMapKeyHistorical[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetInterface()`

contractsGetInterface($address): \Bzzhh\Tzkt\Model\ContractInterface

Get JSON Schema [2020-12] interface for the contract

Returns standard JSON Schema for contract storage, entrypoints, and Big_map entries.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address

try {
    $result = $apiInstance->contractsGetInterface($address);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetInterface: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address

Return type

\Bzzhh\Tzkt\Model\ContractInterface

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetKey()`

contractsGetKey($address, $name, $key, $micheline): \Bzzhh\Tzkt\Model\BigMapKey

Get bigmap key

Returns the specified bigmap key.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$name = 'name_example'; // string | Bigmap name is the last piece of the bigmap storage path.             For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.             If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
$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->contractsGetKey($address, $name, $key, $micheline);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
name	string	Bigmap name is the last piece of the bigmap storage path. For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`. If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
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]

Return type

\Bzzhh\Tzkt\Model\BigMapKey

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetKey2()`

contractsGetKey2($address, $name, $level, $key, $micheline): \Bzzhh\Tzkt\Model\BigMapKeyHistorical

Get historical key

Returns the specified bigmap key at the specific block.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$name = 'name_example'; // string | Bigmap name is the last piece of the bigmap storage path.             For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.             If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
$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->contractsGetKey2($address, $name, $level, $key, $micheline);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetKey2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
name	string	Bigmap name is the last piece of the bigmap storage path. For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`. If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
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]

Return type

\Bzzhh\Tzkt\Model\BigMapKeyHistorical

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetKeyUpdates()`

contractsGetKeyUpdates($address, $name, $key, $sort, $offset, $limit, $micheline): \Bzzhh\Tzkt\Model\BigMapKeyUpdate[]

Get bigmap key updates

Returns updates history for the specified bigmap key.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$name = 'name_example'; // string | Bigmap name is the last piece of the bigmap storage path.             For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.             If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
$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->contractsGetKeyUpdates($address, $name, $key, $sort, $offset, $limit, $micheline);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetKeyUpdates: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
name	string	Bigmap name is the last piece of the bigmap storage path. For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`. If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.
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]

Return type

\Bzzhh\Tzkt\Model\BigMapKeyUpdate[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetRawStorage()`

contractsGetRawStorage($address, $level): \Bzzhh\Tzkt\Model\IMicheline

Get raw contract storage

Returns raw contract storage value in micheline format.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$level = 0; // int | Level at which storage value should be taken. If `0` or not specified, the current value will be returned.

try {
    $result = $apiInstance->contractsGetRawStorage($address, $level);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetRawStorage: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
level	int	Level at which storage value should be taken. If `0` or not specified, the current value will be returned.	[optional] [default to 0]

Return type

\Bzzhh\Tzkt\Model\IMicheline

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetRawStorageHistory()`

contractsGetRawStorageHistory($address, $last_id, $limit): \Bzzhh\Tzkt\Model\StorageRecord[]

Get raw contract storage history

Returns raw contract storage historical values.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$last_id = 0; // int | Id of the last item received (for pagination)
$limit = 10; // int | Maximum number of items to return

try {
    $result = $apiInstance->contractsGetRawStorageHistory($address, $last_id, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetRawStorageHistory: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
last_id	int	Id of the last item received (for pagination)	[optional] [default to 0]
limit	int	Maximum number of items to return	[optional] [default to 10]

Return type

\Bzzhh\Tzkt\Model\StorageRecord[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetRawStorageSchema()`

contractsGetRawStorageSchema($address, $level): \Bzzhh\Tzkt\Model\IMicheline

Get raw contract storage schema

Returns micheline schema (type) of the contract storage.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$level = 0; // int | Level at which storage schema should be taken. If `0` or not specified, the current schema will be returned.

try {
    $result = $apiInstance->contractsGetRawStorageSchema($address, $level);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetRawStorageSchema: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
level	int	Level at which storage schema should be taken. If `0` or not specified, the current schema will be returned.	[optional] [default to 0]

Return type

\Bzzhh\Tzkt\Model\IMicheline

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetSame()`

contractsGetSame($address, $sort, $offset, $limit, $select, $include_storage): \Bzzhh\Tzkt\Model\Contract[]

Get same contracts

Returns contracts which have the same script as the specified one. Note, contract scripts are compared by 32-bit hash, so in very rare cases there may be collisions.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address (starting with KT)
$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.
$include_storage = false; // bool | Specifies whether to include contract storage value in response.

try {
    $result = $apiInstance->contractsGetSame($address, $sort, $offset, $limit, $select, $include_storage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetSame: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address (starting with KT)
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]
include_storage	bool	Specifies whether to include contract storage value in response.	[optional] [default to false]

Return type

\Bzzhh\Tzkt\Model\Contract[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetSimilar()`

contractsGetSimilar($address, $sort, $offset, $limit, $select, $include_storage): \Bzzhh\Tzkt\Model\Contract[]

Get similar contracts

Returns contracts which have the same interface (parameter and storage types) as the specified one. Note, contract parameter and storage types are compared by 32-bit hash, so in very rare cases there may be collisions.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address (starting with KT)
$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.
$include_storage = false; // bool | Specifies whether to include contract storage value in response.

try {
    $result = $apiInstance->contractsGetSimilar($address, $sort, $offset, $limit, $select, $include_storage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetSimilar: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address (starting with KT)
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]
include_storage	bool	Specifies whether to include contract storage value in response.	[optional] [default to false]

Return type

\Bzzhh\Tzkt\Model\Contract[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetStorage()`

contractsGetStorage($address, $level, $path): \SplFileObject

Get contract storage

Returns contract storage value in JSON format.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$level = 0; // int | Level at which storage value should be taken. If `0` or not specified, the current value will be returned.
$path = 'path_example'; // string | Path in the JSON value (point-separated list of field names, e.g. `path=settings.refund_time` to return

try {
    $result = $apiInstance->contractsGetStorage($address, $level, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetStorage: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
level	int	Level at which storage value should be taken. If `0` or not specified, the current value will be returned.	[optional] [default to 0]
path	string	Path in the JSON value (point-separated list of field names, e.g. `path=settings.refund_time` to return	[optional]

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetStorageHistory()`

contractsGetStorageHistory($address, $last_id, $limit): \Bzzhh\Tzkt\Model\StorageRecord[]

Get contract storage history

Returns contract storage historical values.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$last_id = 0; // int | Id of the last item received (for pagination)
$limit = 10; // int | Maximum number of items to return

try {
    $result = $apiInstance->contractsGetStorageHistory($address, $last_id, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetStorageHistory: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
last_id	int	Id of the last item received (for pagination)	[optional] [default to 0]
limit	int	Maximum number of items to return	[optional] [default to 10]

Return type

\Bzzhh\Tzkt\Model\StorageRecord[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`contractsGetStorageSchema()`

contractsGetStorageSchema($address, $level): \SplFileObject

Get contract storage schema

Returns JSON schema of the contract storage.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\ContractsApi(
    // 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()
);
$address = 'address_example'; // string | Contract address
$level = 0; // int | Level at which storage schema should be taken. If `0` or not specified, the current schema will be returned.

try {
    $result = $apiInstance->contractsGetStorageSchema($address, $level);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->contractsGetStorageSchema: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
address	string	Contract address
level	int	Level at which storage schema should be taken. If `0` or not specified, the current schema will be returned.	[optional] [default to 0]

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ContractsApi.md

Latest commit

History

ContractsApi.md

File metadata and controls

Bzzhh\Tzkt\ContractsApi

contractsBuildEntrypointParametersGET()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsBuildEntrypointParametersPOST()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsGetBigMapByName()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsGetBigMapByNameKeys()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsGetBigMaps()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsGetByAddress()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsGetCode()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsGetContractViewByName()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsGetContractViews()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsGetCount()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsGetEntrypointByName()

Example

Parameters

Return type

Authorization

HTTP request headers

contractsGetEntrypoints()

`contractsBuildEntrypointParametersGET()`

`contractsBuildEntrypointParametersPOST()`

`contractsGet()`

`contractsGetBigMapByName()`

`contractsGetBigMapByNameKeys()`

`contractsGetBigMaps()`

`contractsGetByAddress()`

`contractsGetCode()`

`contractsGetContractViewByName()`

`contractsGetContractViews()`

`contractsGetCount()`

`contractsGetEntrypointByName()`

`contractsGetEntrypoints()`

`contractsGetHistoricalKeys()`

`contractsGetInterface()`

`contractsGetKey()`

`contractsGetKey2()`

`contractsGetKeyUpdates()`

`contractsGetRawStorage()`

`contractsGetRawStorageHistory()`

`contractsGetRawStorageSchema()`

`contractsGetSame()`

`contractsGetSimilar()`