wprigollopes/bcb-ptax

API to communicate with Banco Central do Brasil to get currency PTAX based on a specific day

Maintainers

Details

github.com/wprigollopes/bcb-ptax

Source

Issues

Installs: 1

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 1

Forks: 0

Open Issues: 0

dev-master 2021-02-07 11:32 UTC

Requires

MIT b876ad754b5166a17f2bc882790735f25a9c6961

  • William Prigol Lopes <william.prigol.lopes.woop@gmail.com>

This package is auto-updated.

Last update: 2024-04-07 18:32:32 UTC

README

A simple composer package to connect on "Banco Central do Brasil" public API and returns a cotation from BRL to a specific day and currency using Curl

How to install

composer require wprigollopes/bcb-ptax

How to use

You can call use bcbPTAX\PTAX and call statically PTAX::getPTAX(<currency>, <date>, <dateFormat>) passing the currency (1), date (2) and date format (3) parameters. As the API is located on "Banco Central do Brazil", all quotations are converted from "BRL" to <currency>.

use bcbPTAX\PTAX;
$return = PTAX::getPTAX('USD', '2018-04-23', 'Y-m-d');

This will extract the currency quotation on specified day.

Currencies supported (ISO 4217 pattern) - More info in https://en.wikipedia.org/wiki/ISO_4217:

['AFN', 'ETB', 'THB', 'PAB', 'VEF', 'BOB', 'GHS', 'CRC', 'SVC', 'NIO', 'DKK', 'ISK', 'NOK', 'SEK', 'CZK', 'GMD', 'DZD', 'KWD', 'BHD', 'IQD', 'JOD', 'LYD', 'MKD', 'RSD', 'SDG', 'TND', 'SSP', 'SDR', 'MAD', 'AED', 'STD', 'AUD', 'BSD', 'BMD', 'CAD', 'GYD', 'NAD', 'BBD', 'BZD', 'BND', 'KYD', 'SGD', 'CLF', 'FJD', 'HKD', 'TTD', 'XCD', 'USD', 'JMD', 'LRD', 'NZD', 'SBD', 'SRD', 'VND', 'AMD', 'CVE', 'ANG', 'AWG', 'HUF', 'CDF', 'BIF', 'KMF', 'XAF', 'XOF', 'XPF', 'DJF', 'GNF', 'MGA', 'RWF', 'CHF', 'HTG', 'PYG', 'UAH', 'JPY', 'GEL', 'ALL', 'HNL', 'SLL', 'MDL', 'RON', 'BGN', 'GIP', 'EGP', 'GBP', 'FKP', 'LBP', 'SHP', 'SYP', 'SZL', 'LSL', 'TMT', 'MZN', 'ERN', 'NGN', 'AOA', 'TWD', 'TRY', 'PEN', 'BTN', 'MRO', 'MRU', 'TOP', 'MOP', 'ARS', 'CLP', 'COP', 'CUP', 'DOP', 'PHP', 'MXN', 'UYU', 'BWP', 'MWK', 'ZMW', 'GTQ', 'MMK', 'PGK', 'HRK', 'LAK', 'ZAR', 'CNY', 'CNH', 'QAR', 'OMR', 'YER', 'IRR', 'SAR', 'KHR', 'MYR', 'RUB', 'BYN', 'TJS', 'MUR', 'NPR', 'SCR', 'LKR', 'INR', 'IDR', 'MVR', 'PKR', 'ILS', 'KGS', 'UZS', 'BDT', 'WST', 'KZT', 'MNT', 'VUV', 'KRW', 'TZS', 'KES', 'UGX', 'SOS', 'PLN', 'EUR', 'XAU']

Please, feel free to suggest changes!