OpenAPIClient-php

Introduction

TzKT Explorer provides a free REST-like API and WebSocket API for accessing detailed Tezos blockchain data and helps developers build more services and applications on top of Tezos. TzKT is an open-source project, so you can easily clone and build it and use it as a self-hosted service to avoid any risks depending on third-party services.

TzKT API is available for the following Tezos networks with the following base URLs:

• Mainnet: https://api.tzkt.io/ or https://api.mainnet.tzkt.io/ (view docs)
• Edo2net: https://api.edo2net.tzkt.io/ (view docs)
• Florencenet: https://api.florencenet.tzkt.io/ (view docs)

We also provide a staging environment for testing newest features and pre-updating client applications before deploying to production:

• Mainnet staging: https://staging.api.tzkt.io/ or https://staging.api.mainnet.tzkt.io/ (view docs)
• Edo2net staging: https://staging.api.edo2net.tzkt.io/ (view docs)

Feel free to contact us if you have any questions or feature requests. Your feedback really helps us make TzKT better!

• Email: [email protected]
• Twitter: https://twitter.com/TezosBakingBad
• Telegram: tg://resolve?domain=baking_bad_chat
• Slack: https://tezos-dev.slack.com/archives/CV5NX7F2L

And don't forget to star TzKT project on GitHub ;)

Terms of Use

TzKT API is free for everyone and for both commercial and non-commercial usage.

If your application or service uses the TzKT API in any forms: directly on frontend or indirectly on backend, you should mention that fact on your website or application by placing the label "Powered by TzKT API" with a direct link to tzkt.io.

Rate Limits

There will be no rate limits as long as our servers can handle the load without additional infrastructure costs. However, any apparent abuse will be prevented by setting targeted rate limits.

Check out Tezos Explorer API Best Practices and in particular how to optimize requests count.

For more information, please visit https://baking-bad.org/docs.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/bzzhh/tzkt-php-client.git"
    }
  ],
  "require": {
    "bzzhh/tzkt-php-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once "/path/to/OpenAPIClient-php/vendor/autoload.php";

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once __DIR__ . "/vendor/autoload.php";

$apiInstance = new Bzzhh\Tzkt\Api\AccountsApi(
  // 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()
);
$type = new \Bzzhh\Tzkt\Model\OneOfAccountTypeParameter(); // OneOfAccountTypeParameter | Filters accounts by type (`user`, `delegate`, `contract`).
$kind = new \Bzzhh\Tzkt\Model\OneOfContractKindParameter(); // OneOfContractKindParameter | Filters accounts by contract kind (`delegator_contract` or `smart_contract`)
$delegate = new \Bzzhh\Tzkt\Model\OneOfAccountParameter(); // OneOfAccountParameter | Filters accounts by delegate. Allowed fields for `.eqx` mode: none.
$balance = new \Bzzhh\Tzkt\Model\OneOfInt64Parameter(); // OneOfInt64Parameter | Filters accounts by balance
$staked = new \Bzzhh\Tzkt\Model\OneOfBoolParameter(); // OneOfBoolParameter | Filters accounts by participation in staking
$last_activity = new \Bzzhh\Tzkt\Model\OneOfInt32Parameter(); // OneOfInt32Parameter | Filters accounts by last activity level (where the account was updated)
$select = new \Bzzhh\Tzkt\Model\OneOfSelectParameter(); // OneOfSelectParameter | 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\OneOfSortParameter(); // OneOfSortParameter | Sorts delegators by specified field. Supported fields: `id` (default), `balance`, `firstActivity`, `lastActivity`, `numTransactions`, `numContracts`.
$offset = new \Bzzhh\Tzkt\Model\OneOfOffsetParameter(); // OneOfOffsetParameter | Specifies which or how many items should be skipped
$limit = 100; // int | Maximum number of items to return

try {
  $result = $apiInstance->accountsGet(
    $type,
    $kind,
    $delegate,
    $balance,
    $staked,
    $last_activity,
    $select,
    $sort,
    $offset,
    $limit
  );
  print_r($result);
} catch (Exception $e) {
  echo "Exception when calling AccountsApi->accountsGet: ",
    $e->getMessage(),
    PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.tzkt.io

Models

• Account
• AccountMetadata
• AccountMetadataAlias
• AccountParameter
• AccountTypeParameter
• ActivationOperation
• ActivationOperationAllOf
• Alias
• AnnotationType
• BakerRewards
• BakingOperation
• BakingOperationAllOf
• BakingRight
• BakingRightStatusParameter
• BakingRightTypeParameter
• BalanceTooLowError
• BalanceTooLowErrorAllOf
• BallotOperation
• BallotOperationAllOf
• BaseOperationError
• BaseOperationErrorAllOf
• BigMap
• BigMapActionParameter
• BigMapDiff
• BigMapInterface
• BigMapKey
• BigMapKeyHistorical
• BigMapKeyShort
• BigMapKeyUpdate
• BigMapTag
• BigMapTagsParameter
• BigMapUpdate
• Block
• BoolParameter
• Commitment
• Contract
• ContractAllOf
• ContractInterface
• ContractKindParameter
• CreatorInfo
• Cycle
• DateTimeParameter
• Delegate
• DelegateAllOf
• DelegateInfo
• DelegationOperation
• DelegationOperationAllOf
• Delegator
• DelegatorRewards
• DoubleBakingOperation
• DoubleBakingOperationAllOf
• DoubleEndorsingOperation
• DoubleEndorsingOperationAllOf
• EmptyAccount
• EmptyAccountAllOf
• EndorsementOperation
• EndorsementOperationAllOf
• Entrypoint
• EntrypointInterface
• HistoricalBalance
• IAnnotation
• IMicheline
• Int32NullParameter
• Int32Parameter
• Int64Parameter
• JsonParameter
• JsonPath
• JsonPathType
• ManagerInfo
• MichelineFormat
• MichelinePrim
• MichelineType
• MigrationKindParameter
• MigrationOperation
• MigrationOperationAllOf
• NonExistingContractError
• NonExistingContractErrorAllOf
• NonceRevelationOperation
• NonceRevelationOperationAllOf
• OffsetParameter
• Operation
• OperationError
• OperationStatusParameter
• OriginatedContract
• OriginationOperation
• OriginationOperationAllOf
• PeriodInfo
• PrimType
• Proposal
• ProposalAlias
• ProposalMetadata
• ProposalMetadataAlias
• ProposalOperation
• ProposalOperationAllOf
• Protocol
• ProtocolConstants
• ProtocolMetadata
• ProtocolMetadataAlias
• ProtocolParameter
• Quote
• QuoteShort
• RawJson
• RelatedContract
• RevealOperation
• RevealOperationAllOf
• RevelationPenaltyOperation
• RevelationPenaltyOperationAllOf
• RewardSplit
• SelectParameter
• Software
• SoftwareAlias
• SortMode
• SortParameter
• SourceOperation
• SplitDelegator
• State
• Statistics
• StorageRecord
• StringParameter
• Symbols
• TimestampParameter
• TransactionOperation
• TransactionOperationAllOf
• TxParameter
• UnregisteredDelegateError
• UnregisteredDelegateErrorAllOf
• User
• UserAllOf
• ValueTupleOfJsonPathOfAndString
• VoterSnapshot
• VoterStatusParameter
• VotingEpoch
• VotingPeriod

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

[email protected]

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: v1.5
• Build package: org.openapitools.codegen.languages.PhpClientCodegen