Skip to content

Latest commit

 

History

History
185 lines (125 loc) · 5.98 KB

CyclesApi.md

File metadata and controls

185 lines (125 loc) · 5.98 KB
Raw

Bzzhh\Tzkt\CyclesApi

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

Method HTTP request Description
cyclesGet() GET /v1/cycles Get cycles
cyclesGetByIndex() GET /v1/cycles/{index} Get cycle by index
cyclesGetCount() GET /v1/cycles/count Get cycles count

cyclesGet()

cyclesGet($select, $sort, $offset, $limit, $quote): \Bzzhh\Tzkt\Model\Cycle[]

Get cycles

Returns a list of cycles, including future cycles.

Example

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



$apiInstance = new Bzzhh\Tzkt\Api\CyclesApi(
    // 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()
);
$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 cycles by specified field. Supported fields: `index` (default, desc).
$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
$quote = new \Bzzhh\Tzkt\Model\AccountsGetOperationsQuoteParameter(); // AccountsGetOperationsQuoteParameter | Comma-separated list of ticker symbols to inject historical prices into response

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

Parameters

Name Type Description Notes
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 cycles by specified field. Supported fields: `index` (default, desc). [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]
quote AccountsGetOperationsQuoteParameter Comma-separated list of ticker symbols to inject historical prices into response [optional]

Return type

\Bzzhh\Tzkt\Model\Cycle[]

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]

cyclesGetByIndex()

cyclesGetByIndex($index, $quote): \Bzzhh\Tzkt\Model\Cycle

Get cycle by index

Returns a cycle at the specified index.

Example

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



$apiInstance = new Bzzhh\Tzkt\Api\CyclesApi(
    // 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()
);
$index = 56; // int | Cycle index starting from zero
$quote = new \Bzzhh\Tzkt\Model\AccountsGetOperationsQuoteParameter(); // AccountsGetOperationsQuoteParameter | Comma-separated list of ticker symbols to inject historical prices into response

try {
    $result = $apiInstance->cyclesGetByIndex($index, $quote);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CyclesApi->cyclesGetByIndex: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
index int Cycle index starting from zero
quote AccountsGetOperationsQuoteParameter Comma-separated list of ticker symbols to inject historical prices into response [optional]

Return type

\Bzzhh\Tzkt\Model\Cycle

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]

cyclesGetCount()

cyclesGetCount(): int

Get cycles count

Returns the total number of cycles, including future cycles.

Example

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



$apiInstance = new Bzzhh\Tzkt\Api\CyclesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

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

Parameters

This endpoint does not need any parameter.

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]