PHPackages                             rocketfellows/tinkoff-invest-v1-method-get-dividends - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. rocketfellows/tinkoff-invest-v1-method-get-dividends

ActiveLibrary[API Development](/categories/api)

rocketfellows/tinkoff-invest-v1-method-get-dividends
====================================================

v1.0.0(4y ago)04MITPHPPHP >=7.4

Since Jun 26Pushed 4y agoCompare

[ Source](https://github.com/rocketfellows/tinkoff-invest-v1-method-get-dividends)[ Packagist](https://packagist.org/packages/rocketfellows/tinkoff-invest-v1-method-get-dividends)[ RSS](/packages/rocketfellows-tinkoff-invest-v1-method-get-dividends/feed)WikiDiscussions main Synced today

READMEChangelog (1)Dependencies (6)Versions (2)Used By (0)

Tinkoff Invest V1 instruments service get dividends method
==========================================================

[](#tinkoff-invest-v1-instruments-service-get-dividends-method)

[![Code Coverage Badge](./badge.svg)](./badge.svg)

Wrapper over the method for receiving dividend payment events for an instrument.

Provides a set of functions to receive dividends for a different set of query parameters.

Tinkoff swagger difinition [https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService\_GetDividends](https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_GetDividends)

Component content
-----------------

[](#component-content)

The component consists of two basic parts:

- *rocketfellows\\TinkoffInvestV1MethodGetDividends\\DividendsService* - direct destination service to get list of dividends for an instrument
- *adapters* - adapters that implement a way to receive dividends for an instrument

DividendsService
----------------

[](#dividendsservice)

*DividendsService* - service provides functions for requesting a list of instrument dividends.

List of functions and their contract:

- *getAll* - takes figi value of the instrument as an input parameter, returns *Dividends* tuple, throws *SourceFaultException* and *IncorrectInputsFaultException*
- *getBeforeDate* - as input parameters, it takes figi value of the instrument and the date of fixing the register (record\_date) up to which, inclusive, it is necessary to carry out the search, returns *Dividends* tuple, throws *SourceFaultException* and *IncorrectInputsFaultException*
- *getByPeriod* - as input parameters, it takes figi value of the instrument and the range of registry fixing dates in the interval of which it is necessary to search, returns *Dividends* tuple, throws *SourceFaultException* and *IncorrectInputsFaultException*

```
/**
 * @throws SourceFaultException
 * @throws IncorrectInputsFaultException
 */
public function getAll(string $figi): Dividends;

/**
 * @throws SourceFaultException
 * @throws IncorrectInputsFaultException
 */
public function getBeforeDate(string $figi, DateTime $dateTime): Dividends;

/**
 * @throws IncorrectInputsFaultException
 * @throws SourceFaultException
 */
public function getByPeriod(string $figi, DateTime $fromDateTime, DateTime $toDateTime): Dividends;
```

*Figi* - instrument identifier.

*Dividends* - definition - *rocketfellows\\TinkoffInvestV1MethodGetDividends\\models\\Dividends*, an immutable tuple of *Dividend* type objects.

*Dividend* - definition - *rocketfellows\\TinkoffInvestV1MethodGetDividends\\models\\Dividend*, describes the dividend data of the instrument, scheme definition here [https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService\_GetDividends](https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_GetDividends)

*DividendsServiceException* - definition - *rocketfellows\\TinkoffInvestV1MethodGetDividends\\exceptions\\DividendsServiceException*, the base exception abstract class of this component.

*IncorrectInputsFaultException* - definition - *rocketfellows\\TinkoffInvestV1Common\\exceptions\\faults\\IncorrectInputsFaultException*, the exception thrown if the input data for searching for instrument dividends was incorrect, for example searching by figi for a non-existent instrument.

*SourceFaultException* - definition - *rocketfellows\\TinkoffInvestV1Common\\exceptions\\faults\\SourceFaultException*, exception thrown if an error has occurred on the server side of the api tinkoff investment.

*DividendsRequestInterface* - definition - *rocketfellows\\TinkoffInvestV1MethodGetDividends\\DividendsRequestInterface*, the interface with which the *DividendsService* service works to receive data on instrument dividends from various sources. An interface must be implemented by an adapter, such as an adapter for rest, soap, gRpc, etc.

```
/**
* @throws IncorrectInputsFaultException
* @throws SourceFaultException
*/
public function requestAll(string $figi): Dividends;

/**
* @throws IncorrectInputsFaultException
* @throws SourceFaultException
*/
public function requestToDate(string $figi, DateTime $toDateTime): Dividends;

/**
* @throws IncorrectInputsFaultException
* @throws SourceFaultException
*/
public function requestByPeriod(string $figi, DateTime $fromDateTime, DateTime $toDateTime): Dividends;
```

Adapters
--------

[](#adapters)

So far, the REST API described in the swagger file at [https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService\_GetDividends](https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_GetDividends) serves as a source for obtaining information about instrument dividend payments. Therefore, within the framework of this component, a REST API adapter to the *rocketfellows\\TinkoffInvestV1MethodGetDividends\\DividendsRequestInterface* interface is implemented.

Feel free to implement other adapters to get dividend data.

So far list of implemented adapters:

- REST

REST adapter
------------

[](#rest-adapter)

An REST API adapter class that implements the interface *rocketfellows\\TinkoffInvestV1MethodGetDividends\\DividendsRequestInterface* - *rocketfellows\\TinkoffInvestV1MethodGetDividends\\adapters\\rest\\DividendsRequestService*

All contracts of interface implemented in this class, inputs, outputs, exceptions.

The adapter uses as dependency a low-level abstraction to get data on dividends *rocketfellows\\TinkoffInvestV1InstrumentsRestClient\\GetDividendsInterface* - an interface provided in the *rocketfellows/tinkoff-invest-v1-instruments-rest-client* component, link to the component  -v1-instruments-rest-client

REST API adapter usage examples
-------------------------------

[](#rest-api-adapter-usage-examples)

In order to start using the service for receiving data on dividend payments, you need to configure the following:

- low-level REST API client *rocketfellows\\TinkoffInvestV1RestClient\\Client*
- define an implementation of the interface *rocketfellows\\TinkoffInvestV1InstrumentsRestClient\\GetDividendsInterface*
- pass an implementation of the interface *rocketfellows\\TinkoffInvestV1InstrumentsRestClient\\GetDividendsInterface* as a dependency to *rocketfellows\\TinkoffInvestV1MethodGetDividends\\adapters\\rest\\DividendsRequestService*
- pass as a dependency to *rocketfellows\\TinkoffInvestV1MethodGetDividends\\DividendsService* the implementation of the *rocketfellows\\TinkoffInvestV1MethodGetDividends\\DividendsRequestInterface* interface - in this example, it will be the REST API implementation of the *rocketfellows\\TinkoffInvestV1MethodGetDividends\\adapters\\rest\\DividendsRequestService* adapter

Of course, you can make all these preliminary settings through your DI container.

Configuration example:

```
$client = new \rocketfellows\TinkoffInvestV1RestClient\Client(
    (
        new \rocketfellows\TinkoffInvestV1RestClient\ClientConfig(
            'https://invest-public-api.tinkoff.ru/rest',

        )
    ),
    new \GuzzleHttp\Client()
);

$instrumentsService = new \rocketfellows\TinkoffInvestV1InstrumentsRestClient\InstrumentsService($client);

$dividendsRequestService = new \rocketfellows\TinkoffInvestV1MethodGetDividends\adapters\rest\DividendsRequestService($instrumentsService);
```

Service functions call example:

```
$dividends = $dividendsService->getByPeriod(
    'BBG004730RP0',
    new DateTime('2022-05-24T15:38:52.283Z'),
    new DateTime('2022-08-24T15:38:52.283Z'),
);

var_dump($dividends);
```

Output:

```
object(rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividends)#35 (2) {
  ["data":protected]=>
  array(1) {
    [0]=>
    object(rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividend)#38 (10) {
      ["dividendNet":"rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividend":private]=>
      object(rocketfellows\TinkoffInvestV1Common\models\MoneyValue)#36 (3) {
        ["currency":"rocketfellows\TinkoffInvestV1Common\models\MoneyValue":private]=>
        object(arslanimamutdinov\ISOStandard4217\Currency)#23 (3) {
          ["name":"arslanimamutdinov\ISOStandard4217\Currency":private]=>
          string(13) "Russian ruble"
          ["alpha3":"arslanimamutdinov\ISOStandard4217\Currency":private]=>
          string(3) "RUB"
          ["numericCode":"arslanimamutdinov\ISOStandard4217\Currency":private]=>
          string(3) "643"
        }
        ["units":"rocketfellows\TinkoffInvestV1Common\models\MoneyValue":private]=>
        int(52)
        ["nano":"rocketfellows\TinkoffInvestV1Common\models\MoneyValue":private]=>
        int(530000000)
      }
      ["closePrice":"rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividend":private]=>
      object(rocketfellows\TinkoffInvestV1Common\models\MoneyValue)#33 (3) {
        ["currency":"rocketfellows\TinkoffInvestV1Common\models\MoneyValue":private]=>
        object(arslanimamutdinov\ISOStandard4217\Currency)#26 (3) {
          ["name":"arslanimamutdinov\ISOStandard4217\Currency":private]=>
          string(13) "Russian ruble"
          ["alpha3":"arslanimamutdinov\ISOStandard4217\Currency":private]=>
          string(3) "RUB"
          ["numericCode":"arslanimamutdinov\ISOStandard4217\Currency":private]=>
          string(3) "643"
        }
        ["units":"rocketfellows\TinkoffInvestV1Common\models\MoneyValue":private]=>
        int(296)
        ["nano":"rocketfellows\TinkoffInvestV1Common\models\MoneyValue":private]=>
        int(0)
      }
      ["yieldValue":"rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividend":private]=>
      object(rocketfellows\TinkoffInvestV1Common\models\Quotation)#24 (2) {
        ["units":"rocketfellows\TinkoffInvestV1Common\models\Quotation":private]=>
        int(17)
        ["nano":"rocketfellows\TinkoffInvestV1Common\models\Quotation":private]=>
        int(750000000)
      }
      ["paymentDate":"rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividend":private]=>
      NULL
      ["declaredDate":"rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividend":private]=>
      object(DateTime)#22 (3) {
        ["date"]=>
        string(26) "2022-06-30 00:00:00.000000"
        ["timezone_type"]=>
        int(2)
        ["timezone"]=>
        string(1) "Z"
      }
      ["lastBuyDate":"rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividend":private]=>
      object(DateTime)#37 (3) {
        ["date"]=>
        string(26) "2022-07-18 00:00:00.000000"
        ["timezone_type"]=>
        int(2)
        ["timezone"]=>
        string(1) "Z"
      }
      ["recordDate":"rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividend":private]=>
      object(DateTime)#30 (3) {
        ["date"]=>
        string(26) "2022-07-20 00:00:00.000000"
        ["timezone_type"]=>
        int(2)
        ["timezone"]=>
        string(1) "Z"
      }
      ["createdAt":"rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividend":private]=>
      object(DateTime)#39 (3) {
        ["date"]=>
        string(26) "2022-06-26 02:04:44.658320"
        ["timezone_type"]=>
        int(2)
        ["timezone"]=>
        string(1) "Z"
      }
      ["dividendType":"rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividend":private]=>
      string(0) ""
      ["regularity":"rocketfellows\TinkoffInvestV1MethodGetDividends\models\Dividend":private]=>
      string(0) ""
    }
  }
  ["position"]=>
  int(0)
}
```

Contributing
------------

[](#contributing)

Welcome to pull requests. If there is a major changes, first please open an issue for discussion.

Please make sure to update tests as appropriate.

###  Health Score

22

—

LowBetter than 21% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 87.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1469d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/81402dcd0a07ad550b7f80f5871e7c302770b29d4c73a52fc35ba697f702d56e?d=identicon)[arslanim](/maintainers/arslanim)

---

Top Contributors

[![arslanim](https://avatars.githubusercontent.com/u/22678154?v=4)](https://github.com/arslanim "arslanim (68 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (10 commits)")

---

Tags

get-dividends-methodinstruments-servicephpsdktinkoff-invest

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/rocketfellows-tinkoff-invest-v1-method-get-dividends/health.svg)

```
[![Health](https://phpackages.com/badges/rocketfellows-tinkoff-invest-v1-method-get-dividends/health.svg)](https://phpackages.com/packages/rocketfellows-tinkoff-invest-v1-method-get-dividends)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k15](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)