Skip to content

Latest commit

 

History

History
157 lines (116 loc) · 11.9 KB

EventsApi.md

File metadata and controls

157 lines (116 loc) · 11.9 KB
Raw

Bzzhh\Tzkt\EventsApi

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

Method HTTP request Description
eventsGetContractEvents() GET /v1/contracts/events Get contract events
eventsGetContractEventsCount() GET /v1/contracts/events/count Get contract events count

eventsGetContractEvents()

eventsGetContractEvents($id, $level, $timestamp, $contract, $code_hash, $tag, $payload, $transaction_id, $sort, $offset, $limit, $select): \Bzzhh\Tzkt\Model\ContractEvent[]

Get contract events

Returns a list of contract events.

Example

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



$apiInstance = new Bzzhh\Tzkt\Api\EventsApi(
    // 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.
$level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block where the event was emitted.   Click on the parameter to expand more details.
$timestamp = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp (ISO 8601) of the block where the event was emitted.   Click on the parameter to expand more details.
$contract = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by contract address.   Click on the parameter to expand more details.
$code_hash = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by hash of the code of the contract emitted the event.   Click on the parameter to expand more details.
$tag = new \Bzzhh\Tzkt\Model\AccountsGetOperationsEntrypointParameter(); // AccountsGetOperationsEntrypointParameter | Filter by event tag.   Click on the parameter to expand more details.
$payload = new \Bzzhh\Tzkt\Model\AccountsGetOperationsParameterParameter(); // AccountsGetOperationsParameterParameter | Filter by payload.   Note, this parameter supports the following format: `payload{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by (for example, `?payload.foo.bar.in=1,2,3`).   Click on the parameter to expand more details.
$transaction_id = new \Bzzhh\Tzkt\Model\AccountsGetBalanceParameter(); // AccountsGetBalanceParameter | Filter by id of the transaction, in which the event was emitted.   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.

try {
    $result = $apiInstance->eventsGetContractEvents($id, $level, $timestamp, $contract, $code_hash, $tag, $payload, $transaction_id, $sort, $offset, $limit, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->eventsGetContractEvents: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
level AccountsGetIdParameter Filter by level of the block where the event was emitted. Click on the parameter to expand more details. [optional]
timestamp BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp (ISO 8601) of the block where the event was emitted. Click on the parameter to expand more details. [optional]
contract AccountsGetDelegateParameter Filter by contract address. Click on the parameter to expand more details. [optional]
code_hash AccountsGetIdParameter Filter by hash of the code of the contract emitted the event. Click on the parameter to expand more details. [optional]
tag AccountsGetOperationsEntrypointParameter Filter by event tag. Click on the parameter to expand more details. [optional]
payload AccountsGetOperationsParameterParameter Filter by payload. Note, this parameter supports the following format: `payload{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by (for example, `?payload.foo.bar.in=1,2,3`). Click on the parameter to expand more details. [optional]
transaction_id AccountsGetBalanceParameter Filter by id of the transaction, in which the event was emitted. 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]

Return type

\Bzzhh\Tzkt\Model\ContractEvent[]

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]

eventsGetContractEventsCount()

eventsGetContractEventsCount($id, $level, $timestamp, $contract, $code_hash, $tag, $payload, $transaction_id): int

Get contract events count

Returns a total number of contract events.

Example

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



$apiInstance = new Bzzhh\Tzkt\Api\EventsApi(
    // 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.
$level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block where the event was emitted.   Click on the parameter to expand more details.
$timestamp = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp (ISO 8601) of the block where the event was emitted.   Click on the parameter to expand more details.
$contract = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by contract address.   Click on the parameter to expand more details.
$code_hash = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by hash of the code of the contract emitted the event.   Click on the parameter to expand more details.
$tag = new \Bzzhh\Tzkt\Model\AccountsGetOperationsEntrypointParameter(); // AccountsGetOperationsEntrypointParameter | Filter by event tag.   Click on the parameter to expand more details.
$payload = new \Bzzhh\Tzkt\Model\AccountsGetOperationsParameterParameter(); // AccountsGetOperationsParameterParameter | Filter by payload.   Note, this parameter supports the following format: `payload{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by (for example, `?payload.foo.bar.in=1,2,3`).   Click on the parameter to expand more details.
$transaction_id = new \Bzzhh\Tzkt\Model\AccountsGetBalanceParameter(); // AccountsGetBalanceParameter | Filter by id of the transaction, in which the event was emitted.   Click on the parameter to expand more details.

try {
    $result = $apiInstance->eventsGetContractEventsCount($id, $level, $timestamp, $contract, $code_hash, $tag, $payload, $transaction_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->eventsGetContractEventsCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
level AccountsGetIdParameter Filter by level of the block where the event was emitted. Click on the parameter to expand more details. [optional]
timestamp BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp (ISO 8601) of the block where the event was emitted. Click on the parameter to expand more details. [optional]
contract AccountsGetDelegateParameter Filter by contract address. Click on the parameter to expand more details. [optional]
code_hash AccountsGetIdParameter Filter by hash of the code of the contract emitted the event. Click on the parameter to expand more details. [optional]
tag AccountsGetOperationsEntrypointParameter Filter by event tag. Click on the parameter to expand more details. [optional]
payload AccountsGetOperationsParameterParameter Filter by payload. Note, this parameter supports the following format: `payload{.path?}{.mode?}=...`, so you can specify a path to a particular field to filter by (for example, `?payload.foo.bar.in=1,2,3`). Click on the parameter to expand more details. [optional]
transaction_id AccountsGetBalanceParameter Filter by id of the transaction, in which the event was emitted. 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]