https://github.com/mauriciorobayo/trm-api
Wrapper to simplify GET requests and JSON response parsing from the Tasa Representativa del Mercado API.
https://github.com/mauriciorobayo/trm-api
colombia colombian-peso cop dolar exchange-rates tasa-representativa-del-mercado trm usd
Last synced: about 1 month ago
JSON representation
Wrapper to simplify GET requests and JSON response parsing from the Tasa Representativa del Mercado API.
- Host: GitHub
- URL: https://github.com/mauriciorobayo/trm-api
- Owner: MauricioRobayo
- License: mit
- Created: 2020-08-11T18:32:30.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-25T03:05:39.000Z (about 2 months ago)
- Last Synced: 2025-03-27T19:22:27.521Z (about 2 months ago)
- Topics: colombia, colombian-peso, cop, dolar, exchange-rates, tasa-representativa-del-mercado, trm, usd
- Language: TypeScript
- Homepage: https://mauriciorobayo.github.io/trm-api/
- Size: 3.4 MB
- Stars: 19
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TRM API
[](https://badge.fury.io/js/trm-api)
[](https://github.com/MauricioRobayo/trm-api/actions?query=workflow%3A%22Build+and+Release%22)
[](https://codecov.io/gh/MauricioRobayo/trm-api)
[](https://www.codefactor.io/repository/github/mauriciorobayo/trm-api)
The `trm-api` package is a wrapper to simplify GET requests and JSON response parsing from the [Tasa Representativa del Mercado API](https://dev.socrata.com/foundry/www.datos.gov.co/32sa-8pi3).
## Install
```
npm install trm-api
```
## Usage
The `TrmApi` class provides five methods: [`latest()`](#latest), [`between(options)`](#betweenoptions), [`history(options?)`](#historyoptions), [`date(date)`](#datedate), and [`query(query)`](#queryquery).
### CommonJS
```js
const TrmApi = require("trm-api").default;
const trmApi = new TrmApi();
```
### ES6 Modules
```js
import TrmApi from "trm-api";
const trmApi = new TrmApi();
```
### TypeScript
The module is written in TypeScript and type definitions files are included.
### App Token
A limited number of requests can be made without an app token, but they are subject to much lower throttling limits than requests that do include one.
With an app token, your application is guaranteed access to it's own pool of requests.
👉 [Sign up for an app token!](https://www.datos.gov.co/profile/edit/developer_settings)
You can pass your app token in the constructor:
```js
const trmApi = new TrmApi("YOUR-APP-TOKEN-HERE");
```
### Methods
- [`latest()`](#latest)
- [`between(options)`](#betweenoptions)
- [`history(options?)`](#historyoptions)
- [`date(date)`](#datedate)
- [`query(query)`](#queryquery).
#### `latest()`
Provides the most recent quote:
```js
trmApi
.latest()
.then((data) => console.log(data))
.catch((error) => console.log(error));
```
The response is a single object with the latest information from the [Tasa Representativa del Mercado API](https://dev.socrata.com/foundry/www.datos.gov.co/32sa-8pi3):
```js
{
valor: '3792.98',
unidad: 'COP',
vigenciadesde: '2020-08-05T00:00:00.000',
vigenciahasta: '2020-08-05T00:00:00.000'
}
```
#### `between(options)`
Returns an array with the quotes between two dates: `startAt` and `endAt`.
The `options` argument is an object with the following fields:
| Field | Type | Description |
| ------- | -------- | -------------------------------------------------------------------- |
| startAt | Required | The initial date of the data to be retrieved in `YYYY-MM-DD` format. |
| endAt | Required | The final date of the data to be retrieved in `YYYY-MM-DD` format. |
| order? | Optional | Can be `'ASC'` or `'DESC'`. Defaults to `'ASC'`. |
```js
trmApi
.between({ startAt: "2020-07-02", endAt: "2020-07-7", order: "DESC" })
.then((data) => console.log(data))
.catch((error) => console.log(error));
```
Will return the following array:
```js
[
{
valor: "3633.32",
unidad: "COP",
vigenciadesde: "2020-07-07T00:00:00.000",
vigenciahasta: "2020-07-07T00:00:00.000",
},
{
valor: "3645.90",
unidad: "COP",
vigenciadesde: "2020-07-04T00:00:00.000",
vigenciahasta: "2020-07-06T00:00:00.000",
},
{
valor: "3660.18",
unidad: "COP",
vigenciadesde: "2020-07-03T00:00:00.000",
vigenciahasta: "2020-07-03T00:00:00.000",
},
{
valor: "3723.67",
unidad: "COP",
vigenciadesde: "2020-07-02T00:00:00.000",
vigenciahasta: "2020-07-02T00:00:00.000",
},
];
```
#### `history(options?)`
Returns an array with all the values starting from the most recent value.
The `options` optional argument is an object with the following fields:
| Field | Type | Description |
| ------ | -------- | -------------------------------------------------------------------------- |
| order? | Optional | Can be `'ASC'` or `'DESC'`. Defaults to `ASC`. |
| limit? | Optional | Maximum number of results to return. Defaults to 1,000. Maximum of 50,000. |
```js
trmApi
.history({ limit: 30 })
.then((data) => console.log(data))
.catch((error) => console.log(error));
```
#### `date(date)`
Returns the TRM for an specific date given in `YYYY-MM-DD` format.
```js
trmApi
.date("2020-08-09")
.then((data) => console.log(data))
.catch((error) => console.log(error));
```
The response is a single object with the information for the given date:
```js
{
valor: '3769.67',
unidad: 'COP',
vigenciadesde: '2020-08-07T00:00:00.000',
vigenciahasta: '2020-08-10T00:00:00.000'
}
```
#### `query(query)`
This method allows you to use any custom [`SoQL query`](https://dev.socrata.com/docs/queries/).
For example:
```js
trmApi
.query(
"SELECT valor, vigenciadesde WHERE valor >= 4150 AND vigenciadesde < '2020-08-01'"
)
.then((data) => console.log(data))
.catch((error) => console.log(error));
```
It will return an array of objects each with the requested fields (or all the fields if no SELECT clause used):
```js
[
{
valor: "4153.91",
vigenciadesde: "2020-03-20T00:00:00.000",
},
];
```
## CLI
The packages provides a simple CLI to quickly get TRM quotes.
If called without arguments it will return the current exchange rate:
```
$ npx --quiet trm-api
3767.05
```
It can also be called with a given date in `YYYY-MM-DD` format to get the exchange rate for that date:
```
$ npx --quiet trm-api 2010-09-23
1803.71
```
## Contributing
Contributions, issues and feature requests are welcome!
## Show your support
Give a ⭐️ if you like this project!
## License
[MIT](LICENSE)