Download the PHP package rocketfellows/tinkoff-invest-v1-method-get-dividends without Composer

On this page you can find all versions of the php package rocketfellows/tinkoff-invest-v1-method-get-dividends. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of rocketfellows/tinkoff-invest-v1-method-get-dividends

Informations about the package tinkoff-invest-v1-method-get-dividends

Tinkoff Invest V1 instruments service get dividends method

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

Component content

The component consists of two basic parts:

DividendsService

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

List of functions and their contract:

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

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.

Adapters

So far, the REST API described in the swagger file at 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 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 https://github.com/rocketfellows/tinkoff-invest -v1-instruments-rest-client

REST API adapter usage examples

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

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

Configuration example:

Service functions call example:

Output:

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.

All versions of tinkoff-invest-v1-method-get-dividends with dependencies

PHP Build Version
Package Version
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rocketfellows/tinkoff-invest-v1-method-get-dividends contains the following files

Loading the files please wait ....