marekskopal/openfigi

OpenFIGI API client library

Maintainers

Package info

github.com/marekskopal/openfigi

pkg:composer/marekskopal/openfigi

Statistics

Installs: 640

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v1.0.0 2026-03-10 17:43 UTC

This package is auto-updated.

Last update: 2026-03-10 19:13:27 UTC


README

Unofficial PHP API client library for the OpenFIGI API service.

Install

composer require marekskopal/openfigi

Usage

use MarekSkopal\OpenFigi\Config\Config;
use MarekSkopal\OpenFigi\Dto\MappingJob;
use MarekSkopal\OpenFigi\Enum\IdTypeEnum;
use MarekSkopal\OpenFigi\OpenFigi;

// Create OpenFigi instance
$openFigi = new OpenFigi(new Config(apiKey: '<yourApiKey>'));

// Map a single ticker to FIGI
$mappingJob = new MappingJob(idType: IdTypeEnum::Ticker, idValue: 'AAPL');
$mappingResults = $openFigi->mapping([$mappingJob]);

// Search for securities
$searchResult = $openFigi->search(query: 'Apple');

// Filter securities
$filterResult = $openFigi->filter(exchCode: 'US', securityType: 'Common Stock');

// Get allowed values for a mapping key
$values = $openFigi->values(MappingValuesKeyEnum::ExchCode);

Covered endpoints

  • Mapping ✅
  • Search ✅
  • Filter ✅
  • Values ✅

Notice

This is NOT an official OpenFIGI library, and the authors of this library are not affiliated with OpenFIGI or Bloomberg Finance L.P. in any way, shape or form.

Contributing

If you want to contribute, feel free to submit a pull request.