{"_id":"@allratestoday/sama-exchange-rate","_rev":"6-999769e07890d5a7cb95b7967cbc62ef","name":"@allratestoday/sama-exchange-rate","dist-tags":{"latest":"1.3.4"},"versions":{"1.2.6":{"name":"@allratestoday/sama-exchange-rate","version":"1.2.6","keywords":["sama","saudi","central","bank","(sama)","exchange-rate","exchange-rates","currency","forex","fx","sar","central-bank","official-rates","saudi-arabia","api","typescript"],"author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"license":"MIT","_id":"@allratestoday/sama-exchange-rate@1.2.6","maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"homepage":"https://allratestoday.com/central-bank-rates-api/sama/","bugs":{"url":"https://github.com/AllRates-Today/sama-exchange-rate/issues"},"dist":{"shasum":"2668dac8689809c7e0d8c7226031fc0af4e6730c","tarball":"https://registry.npmjs.org/@allratestoday/sama-exchange-rate/-/sama-exchange-rate-1.2.6.tgz","fileCount":6,"integrity":"sha512-fOKhqqReMFk+M5VpCUasBhGM+GZ9ULA2SBW14p6CiAdUpf6a1Tv/Arw2JyjT5s6Zv98zTaGK6kmygv4ZusANEg==","signatures":[{"sig":"MEYCIQCp8Ser7qM3TTac1/wqfOxtzJNrKhl6FlnhuzOIpXe5bAIhAIJg/TeWKP7TXyF0zmfuygklM98BYR6TjsVRA1ej3k0C","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":17213},"main":"./index.cjs","type":"module","types":"./index.d.ts","module":"./index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./index.d.ts","import":"./index.mjs","require":"./index.cjs"}},"gitHead":"d5df2aed437aee87e15d3c12a31257edf9b9515a","_npmUser":{"name":"chathurangac8","email":"basnayakac8@gmail.com"},"repository":{"url":"git+https://github.com/AllRates-Today/sama-exchange-rate.git","type":"git"},"_npmVersion":"9.2.0","description":"Official Saudi Central Bank (SAMA) (Saudi Arabia) monthly exchange rates — 12 currencies vs SAR, history since 2009. Zero-dependency Node.js/TypeScript client.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/sama-exchange-rate_1.2.6_1787234208143_0.7004024386046628","host":"s3://npm-registry-packages-npm-production"}},"1.2.7":{"name":"@allratestoday/sama-exchange-rate","version":"1.2.7","keywords":["sama","saudi","central","bank","(sama)","exchange-rate","exchange-rates","currency","forex","fx","sar","central-bank","official-rates","saudi-arabia","api","typescript"],"author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"license":"MIT","_id":"@allratestoday/sama-exchange-rate@1.2.7","maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"homepage":"https://allratestoday.com/central-bank-rates-api/sama/","bugs":{"url":"https://github.com/AllRates-Today/sama-exchange-rate/issues"},"dist":{"shasum":"92595ff30ba08bd7e1381dc6c2d1d003e7f530b4","tarball":"https://registry.npmjs.org/@allratestoday/sama-exchange-rate/-/sama-exchange-rate-1.2.7.tgz","fileCount":6,"integrity":"sha512-jPWv54Kc0KdcI7yrXXzS1o3aqKrfGd55CWS9HD+rPRvSw1CcSskqvojPv4CAF00vCUWZ3nBlkCo+/AT/4RT6kA==","signatures":[{"sig":"MEUCIQCoIK+cbmKoYMmOn1zgyPE1v4Na/x6Aepsv6oVhJ1gE8QIgN7b8tzj5clpb1MWMrbXTDHljj0u2gM+bMJcYeth696g=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":17213},"main":"./index.cjs","type":"module","types":"./index.d.ts","module":"./index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./index.d.ts","import":"./index.mjs","require":"./index.cjs"}},"gitHead":"0bdc92d850f026c2ce3ab23033ab006807b0ecfc","_npmUser":{"name":"chathurangac8","email":"basnayakac8@gmail.com"},"repository":{"url":"git+https://github.com/AllRates-Today/sama-exchange-rate.git","type":"git"},"_npmVersion":"9.2.0","description":"Official Saudi Central Bank (SAMA) (Saudi Arabia) monthly exchange rates — 12 currencies vs SAR, history since 2009. Zero-dependency Node.js/TypeScript client.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/sama-exchange-rate_1.2.7_1787567128826_0.10193025423840085","host":"s3://npm-registry-packages-npm-production"}},"1.3.0":{"name":"@allratestoday/sama-exchange-rate","version":"1.3.0","keywords":["sama","saudi","central","bank","(sama)","exchange-rate","exchange-rates","currency","forex","fx","sar","central-bank","official-rates","saudi-arabia","api","typescript"],"author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"license":"MIT","_id":"@allratestoday/sama-exchange-rate@1.3.0","maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"homepage":"https://allratestoday.com/central-bank-rates-api/sama/","bugs":{"url":"https://github.com/AllRates-Today/sama-exchange-rate/issues"},"dist":{"shasum":"9ba002762eb2878989a98c41acfbcfe688c24203","tarball":"https://registry.npmjs.org/@allratestoday/sama-exchange-rate/-/sama-exchange-rate-1.3.0.tgz","fileCount":6,"integrity":"sha512-3eGxpLdV6GjepWXyIEMu3s3CCdBsAeBDz9ePfnHmb0eC26L7/NaLtTdnZYS0BcIaIXLR1rraG6TdDSVo4GM3YQ==","signatures":[{"sig":"MEQCIHp9xSRV7tJYoJ17+aKzLCaUS0vb/MCrKqdJYlxg546cAiBJWZIZVPC8KOsQ9XtTrb6StUWAFqpK8nnF7rDr0nrhvA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":17763},"main":"./index.cjs","type":"module","types":"./index.d.ts","module":"./index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./index.d.ts","import":"./index.mjs","require":"./index.cjs"}},"gitHead":"ec4d6bcf08cf485c7ab237f12d27e3d5a0f97e14","_npmUser":{"name":"chathurangac8","email":"basnayakac8@gmail.com"},"repository":{"url":"git+https://github.com/AllRates-Today/sama-exchange-rate.git","type":"git"},"_npmVersion":"9.2.0","description":"Official Saudi Central Bank (SAMA) (Saudi Arabia) monthly exchange rates — 12 currencies vs SAR, history since 2009. Zero-dependency Node.js/TypeScript client.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/sama-exchange-rate_1.3.0_1788977235553_0.6416248667180395","host":"s3://npm-registry-packages-npm-production"}},"1.3.1":{"name":"@allratestoday/sama-exchange-rate","version":"1.3.1","keywords":["sama","saudi","central","bank","(sama)","exchange-rate","exchange-rates","currency","forex","fx","sar","central-bank","official-rates","saudi-arabia","api","typescript"],"author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"license":"MIT","_id":"@allratestoday/sama-exchange-rate@1.3.1","maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"homepage":"https://allratestoday.com/central-bank-rates-api/sama/","bugs":{"url":"https://github.com/AllRates-Today/sama-exchange-rate/issues"},"dist":{"shasum":"e0b594908e2ecc04509061f395862314c5065703","tarball":"https://registry.npmjs.org/@allratestoday/sama-exchange-rate/-/sama-exchange-rate-1.3.1.tgz","fileCount":6,"integrity":"sha512-XZSuei/OjI98h1/EqFSHJEBmCtab+PQixgFx6uLtI9k1KCRR3h5S7OhgWUF/XZ+r0FUNpSMqdIwq34nob5CgLA==","signatures":[{"sig":"MEUCIQCfkkJpEN7cf2/jy5y6z/LTHqGPCWW9yINHZcHVUyJ6MQIgRRWjwVFJbXFeAekMt8FN6WzeWaaRFNX9YGDT3/cSOrA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":21730},"main":"./index.cjs","type":"module","types":"./index.d.ts","module":"./index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./index.d.ts","import":"./index.mjs","require":"./index.cjs"}},"gitHead":"fc26fa33ba7dd14ed15e95764a0cdb2b1355358f","_npmUser":{"name":"chathurangac8","email":"basnayakac8@gmail.com"},"repository":{"url":"git+https://github.com/AllRates-Today/sama-exchange-rate.git","type":"git"},"_npmVersion":"9.2.0","description":"Official Saudi Central Bank (SAMA) (Saudi Arabia) monthly exchange rates — 12 currencies vs SAR, history since 2009. Zero-dependency Node.js/TypeScript client.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/sama-exchange-rate_1.3.1_1789650305224_0.8745574184441953","host":"s3://npm-registry-packages-npm-production"}},"1.3.3":{"name":"@allratestoday/sama-exchange-rate","version":"1.3.3","keywords":["sama","saudi","central","bank","(sama)","exchange-rate","exchange-rates","currency","forex","fx","sar","central-bank","official-rates","saudi-arabia","api","typescript"],"author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"license":"MIT","_id":"@allratestoday/sama-exchange-rate@1.3.3","maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"homepage":"https://allratestoday.com/central-bank-rates-api/sama/","bugs":{"url":"https://github.com/AllRates-Today/sama-exchange-rate/issues"},"dist":{"shasum":"88f962bf60225ed1dc9c69b6a749cfdaac7ae7e4","tarball":"https://registry.npmjs.org/@allratestoday/sama-exchange-rate/-/sama-exchange-rate-1.3.3.tgz","fileCount":6,"integrity":"sha512-WNxuTnqtgXAqb28tkarKBG/ETsJausJNXDNRt7cAHSgAw/zc7zK3YGqPQBH3mv/htoGkqcXtuKm7+irESAZeAQ==","signatures":[{"sig":"MEYCIQCM0gGtJjaYlm2hnB3nCsT9HaRkQtOwlPsPmx4PvmHBMAIhAMk8QOurOtDV28BHXeOIboiBV75XGhI9Z35V4EMVAWBN","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEUCIQC80wT5wVTkdsSLhyWHOl3PTHNkjqIXUmdM8u5kHZOLTwIgAlWsEn+6GOiMXWjQVNT6yAjB6ww7EeiK40eCejfJkMU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":21727},"main":"./index.cjs","type":"module","types":"./index.d.ts","module":"./index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./index.d.ts","import":"./index.mjs","require":"./index.cjs"}},"gitHead":"ca0b6b268a0b3c562dedb06b2ec12ac8815a6a05","_npmUser":{"name":"chathurangac8","email":"basnayakac8@gmail.com"},"repository":{"url":"git+https://github.com/AllRates-Today/sama-exchange-rate.git","type":"git"},"_npmVersion":"9.2.0","description":"Official Saudi Central Bank (SAMA) (Saudi Arabia) monthly exchange rates — 12 currencies vs SAR, history since 2009. Zero-dependency Node.js/TypeScript client.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/sama-exchange-rate_1.3.3_1790770480803_0.7597200990698869","host":"s3://npm-registry-packages-npm-production"}},"1.3.4":{"_id":"@allratestoday/sama-exchange-rate@1.3.4","bugs":{"url":"https://github.com/AllRates-Today/sama-exchange-rate/issues"},"dist":{"shasum":"984652eb1e3688ce4d976ce8d0c9ba41ab3e83e5","tarball":"https://registry.npmjs.org/@allratestoday/sama-exchange-rate/-/sama-exchange-rate-1.3.4.tgz","fileCount":6,"integrity":"sha512-x9ulpHWLuEOCvWOXTAH3wY/34eAaQpzZ+wEl+d6cZ68Vm5DNL7++RYj5uDdP+brBcNFvcRgM1xOSDhZDNs/QEg==","signatures":[{"sig":"MEUCIQDV1jWlqjpb3DWxWn6zJsLrUsHt6NfM7s0oxasxLeKZEAIgU3C+/LtrKhkWRZkn0jrlazD2OCnytvhDU/VdTyDu+6w=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCpq0jYjEYBmXGdS7a3xAyA0zUgLTE6S2sLivUSVjIcZQIhAP9efCnROMm46oJXMCaoarme64dAffPhXaQuFGDqRkNE"}],"unpackedSize":22127},"main":"./index.cjs","name":"@allratestoday/sama-exchange-rate","type":"module","types":"./index.d.ts","author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"module":"./index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./index.d.ts","import":"./index.mjs","require":"./index.cjs"}},"gitHead":"79b405ca4251d0e8c85b00c9f6c63206e5e3dab3","license":"MIT","version":"1.3.4","_npmUser":{"name":"chathurangac8","email":"basnayakac8@gmail.com"},"homepage":"https://allratestoday.com/central-bank-rates-api/sama/","keywords":["sama","saudi","central","bank","(sama)","exchange-rate","exchange-rates","currency","forex","fx","sar","central-bank","official-rates","saudi-arabia","api","typescript"],"repository":{"url":"git+https://github.com/AllRates-Today/sama-exchange-rate.git","type":"git"},"_npmVersion":"9.2.0","description":"Official Saudi Central Bank (SAMA) (Saudi Arabia) monthly exchange rates — 12 currencies vs SAR, history since 2009. Zero-dependency Node.js/TypeScript client.","directories":{},"maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"sideEffects":false,"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sama-exchange-rate_1.3.4_1790851503574_0.6447044485532838"}}},"time":{"created":"2026-08-20T13:56:47.960Z","modified":"2026-10-01T10:45:03.865Z","1.2.6":"2026-08-20T13:56:48.267Z","1.2.7":"2026-08-24T10:25:28.961Z","1.3.0":"2026-09-09T18:07:15.707Z","1.3.1":"2026-09-17T13:05:05.367Z","1.3.3":"2026-09-30T12:14:40.896Z","1.3.4":"2026-10-01T10:45:03.650Z"},"bugs":{"url":"https://github.com/AllRates-Today/sama-exchange-rate/issues"},"author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"license":"MIT","homepage":"https://allratestoday.com/central-bank-rates-api/sama/","keywords":["sama","saudi","central","bank","(sama)","exchange-rate","exchange-rates","currency","forex","fx","sar","central-bank","official-rates","saudi-arabia","api","typescript"],"repository":{"url":"git+https://github.com/AllRates-Today/sama-exchange-rate.git","type":"git"},"description":"Official Saudi Central Bank (SAMA) (Saudi Arabia) monthly exchange rates — 12 currencies vs SAR, history since 2009. Zero-dependency Node.js/TypeScript client.","maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"readme":"# Saudi Central Bank (SAMA) Exchange Rates API — sama-exchange-rate\n\n[![npm version](https://img.shields.io/npm/v/@allratestoday%2Fsama-exchange-rate.svg)](https://www.npmjs.com/package/@allratestoday/sama-exchange-rate)\n[![license](https://img.shields.io/npm/l/@allratestoday%2Fsama-exchange-rate.svg)](https://github.com/AllRates-Today/sama-exchange-rate/blob/main/LICENSE)\n[![zero dependencies](https://img.shields.io/badge/dependencies-0-brightgreen.svg)](https://www.npmjs.com/package/@allratestoday/sama-exchange-rate)\n[![TypeScript](https://img.shields.io/badge/TypeScript-types%20included-3178C6.svg)](https://www.typescriptlang.org/)\n\n**Official Saudi Central Bank (SAMA) (Saudi Arabia) monthly exchange rates for Node.js and TypeScript. The published central bank rates behind tax filings, customs valuations, audits, and compliant invoicing — not market estimates, but the numbers Saudi Central Bank (SAMA) itself prints, every month.**\n\n## 🚀 Why this client?\n\n- 🏛️ **Official published rates** — Saudi Central Bank (SAMA)'s own table, with the publisher's own `rate_date` on every response\n- 📅 **History back to 2009** — point-in-time tables and daily series for any past date\n- 🔀 **Published vs derived, always flagged** — computed inverse/cross pairs carry `derived: true`, never mixed with official prints\n- ⚡ **Zero dependencies** — pure ESM + CJS over global `fetch`; Node 18+, Bun, Deno, and edge runtimes\n- 🔷 **Type-safe** — full TypeScript definitions shipped with the package\n- 🧾 **Compliance-grade metadata** — `rate_type`, publication date, and source disclaimer on every response\n\n> **Official rate, not mid-market:** every value here is a number Saudi Central Bank (SAMA) itself published, fixed once printed and carrying the central bank's own `rate_date` — what filings and audits require. Need the live mid-market rate for pricing or display instead? Use the [mid-market API](https://allratestoday.com/docs/) or [`@allratestoday/sdk`](https://www.npmjs.com/package/@allratestoday/sdk). The two can diverge by several percent.\n\n## ⚡ Try it without a key\n\nThe latest Saudi Central Bank (SAMA) table is also served keyless, CORS-open and edge-cached, for evaluation, embeds and AI agents:\n\n```bash\ncurl \"https://allratestoday.com/api/open/central-bank/sama?source=EUR&target=SAR\"\n```\n\n```js\nconst r = await fetch('https://allratestoday.com/api/open/central-bank/sama').then((x) => x.json());\nconsole.log(r.rate_date, r.rates.length); // the central bank's latest published table, no key\n```\n\nThe open endpoint serves the *latest* table only and asks for a visible attribution link. The client below uses the keyed API, which adds point-in-time tables, history, and CSV/XML/Excel output.\n\n## 🔑 Get your API key\n\nGet a free API key at [allratestoday.com/register](https://allratestoday.com/register) — no credit card required. Latest rates are on every plan, including free.\n\n## 📦 Installation\n\n```bash\nnpm install @allratestoday/sama-exchange-rate\n```\n\n```bash\nyarn add @allratestoday/sama-exchange-rate\n```\n\n```bash\npnpm add @allratestoday/sama-exchange-rate\n```\n\nRequires Node 18+ (global `fetch`); also runs on Bun, Deno and edge runtimes. Scoped mirror of [`sama-exchange-rate`](https://www.npmjs.com/package/sama-exchange-rate) — same code, same versions.\n\n## 🏁 Quick start\n\n```js\nimport { getRate } from '@allratestoday/sama-exchange-rate';\n\nconst pair = await getRate('EUR', 'SAR', { apiKey: 'art_live_...' });\nconsole.log(pair.rate, pair.rate_date); // the official Saudi Central Bank (SAMA) rate, on the central bank's own date\n```\n\n## 📚 API reference\n\n- [Latest pair rate](#latest-pair-rate) — one pair from the latest published table\n- [Full published table](#full-published-table) — everything the central bank printed, in one call\n- [Table for a date](#table-for-a-date) — the official table for an invoice or filing date\n- [Daily time series](#daily-time-series) — one pair across a date range\n\n---\n\n### Latest pair rate\n\nFree plan and up. Pairs the central bank does not print directly are resolved from its table and flagged (see *Published vs derived rates* below).\n\n```js\nconst pair = await getRate('EUR', 'SAR', { apiKey: 'art_live_...' });\n```\n\n**Response:**\n\n```javascript\n{\n  bank: 'sama',\n  name: 'Saudi Central Bank (SAMA)',\n  rate_date: '2026-07-31',   // Saudi Central Bank (SAMA)'s own publication date\n  source: 'EUR',\n  target: 'SAR',\n  rate: 4.2976014,\n  rate_type: 'close',\n  derived: false,\n  method: 'published',\n  disclaimer: 'Official rates as published by the named central bank. On weekends/holidays the most recent published rate_date is returned.'\n}\n```\n\n### Full published table\n\nFree plan and up. The complete table for the latest publication date.\n\n```js\nimport { getLatestRates } from '@allratestoday/sama-exchange-rate';\n\nconst table = await getLatestRates({ apiKey: 'art_live_...' });\nconsole.log(table.rate_date, table.rates.length);\n```\n\n**Response:**\n\n```javascript\n{\n  bank: 'sama',\n  name: 'Saudi Central Bank (SAMA)',\n  rate_date: '2026-07-31',\n  rates: [\n    { \"base\": \"EUR\", \"quote\": \"SAR\", \"type\": \"close\", \"value\": 4.2976014 },\n    { \"base\": \"EUR\", \"quote\": \"SAR\", \"type\": \"monthly_average\", \"value\": 4.2804897 },\n    // … the rest of the published table (12 currencies vs SAR)\n  ],\n  disclaimer: '…'\n}\n```\n\n### Table for a date\n\nPaid plans. The official table for any date since 2009 — weekends and holidays return the most recent published date, flagged via `published_on_requested_date`, which is exactly the in-force rate a filing needs.\n\n```js\nimport { getRatesForDate } from '@allratestoday/sama-exchange-rate';\n\nconst day = await getRatesForDate('2026-06-30', { apiKey: 'art_live_...' });\n// Optionally narrow to one pair:\nconst one = await getRatesForDate('2026-06-30', { apiKey: 'art_live_...', source: 'EUR', target: 'SAR' });\n```\n\n**Response:**\n\n```javascript\n{\n  bank: 'sama',\n  requested_date: '2026-06-30',\n  rate_date: '2026-06-30',                // the date actually published\n  published_on_requested_date: true,      // false when a weekend/holiday fell back\n  rates: [ /* the full table for that date */ ],\n  disclaimer: '…'\n}\n```\n\n### Daily time series\n\nPaid plans. One resolved rate per publication date — ready for charting, revaluation runs, or audit workpapers.\n\n```js\nimport { getHistory } from '@allratestoday/sama-exchange-rate';\n\nconst series = await getHistory(\n  { source: 'EUR', target: 'SAR', from: '2026-01-01', to: '2026-07-31' },\n  { apiKey: 'art_live_...' }\n);\n```\n\n**Response:**\n\n```javascript\n{\n  bank: 'sama',\n  source: 'EUR',\n  target: 'SAR',\n  from: '2026-01-01',\n  to: '2026-07-31',\n  count: 152,\n  rates: [\n    // one entry per publication date\n    { date: '2026-07-31', rate: 4.2976014, rate_type: 'close', derived: false, method: 'published' },\n    // …\n  ],\n  disclaimer: '…'\n}\n```\n\nPass `{ symbol: 'EUR' }` instead of `source`/`target` to get the raw published rows for one currency (all rate types, no pair resolution).\n\n---\n\n## 🗺️ Currencies covered\n\nSaudi Central Bank (SAMA) currently publishes rates covering **12 currencies** against the SAR (as of the latest table):\n\n🇦🇺 `AUD` · 🇧🇷 `BRL` · 🇨🇭 `CHF` · 🇨🇳 `CNY` · 🇪🇺 `EUR` · 🇬🇧 `GBP` · 🇮🇳 `INR` · 🇯🇵 `JPY` · 🇰🇷 `KRW` · 🇹🇭 `THB` · 🇹🇷 `TRY` · 🇺🇸 `USD`\n\n## 🏛️ Source\n\nThe Saudi Central Bank (SAMA) publishes riyal exchange rates monthly — period averages and end-of-period values for 12 currencies — with the riyal itself pegged to the US dollar at 3.75 since 1986. SAMA offers no machine-readable feed of its own, so this series is sourced from the KAPSARC open-data mirror of SAMA’s table and typically trails the calendar by about two months.\n\n- Publisher's own page: [Exchange rates — KAPSARC open-data mirror](https://datasource.kapsarc.org/explore/dataset/exchange-rate/) · [www.sama.gov.sa](https://www.sama.gov.sa)\n- Publication: every month; the exact schedule, freshness status and any current delay are on the [Saudi Central Bank (SAMA) rates page](https://allratestoday.com/central-bank-rates-api/sama/)\n- Values are stored unmodified, with the publisher's own `rate_date` on every row — see the [methodology](https://allratestoday.com/official-rates-methodology/)\n\n## 🧭 Reading the numbers\n\n- `value` is always **quote currency per 1 unit of base currency** (`base: \"EUR\", quote: \"USD\", value: 1.15` means 1 EUR = 1.15 USD).\n- Saudi Central Bank (SAMA) quotes **SAR per 1 unit of foreign currency** (e.g. `base: \"USD\", quote: \"SAR\"` means SAR per one US dollar).\n- Need the other way round? Ask `getRate(target, source)` and the API inverts or crosses for you, flagged `derived: true` — never divide a published rate yourself in a compliance workflow.\n- `rate_type` tells you which of the central bank's series a row belongs to (`close` here); some publishers print buy/sell or several fixings for the same pair.\n\n## 🧩 ERP & accounting systems\n\nLoading the official Saudi Central Bank (SAMA) rate into an accounting system is a supported workflow, not a hack. Step-by-step guides with the direction each system expects:\n\n- [Dynamics 365 Business Central](https://allratestoday.com/docs/integrations/business-central/) — built-in Currency Exchange Rate Service, no code\n- [Xero](https://allratestoday.com/docs/integrations/xero/) · [QuickBooks Online](https://allratestoday.com/docs/integrations/quickbooks/) · [SAP S/4HANA and ECC](https://allratestoday.com/docs/integrations/sap/) · [Odoo](https://allratestoday.com/docs/integrations/odoo/)\n\nThe same keyed endpoints return `?format=csv`, `?format=xml` and `?format=xlsx`, and accept the key as `?api_key=` on the URL for importers that cannot send headers:\n\n```bash\ncurl \"https://allratestoday.com/api/v1/central-bank/sama/latest?format=xml&api_key=art_live_...\"\n```\n\n## 🤖 AI agents\n\n- MCP server: `npx -y @allratestoday/central-bank-mcp` (stdio) or the hosted endpoint `https://allratestoday.com/api/mcp` — tools for official rates, history, cross-bank comparison and publication calendars\n- Already using the general SDK or MCP server? Since 2026-10-01 [`@allratestoday/sdk`](https://www.npmjs.com/package/@allratestoday/sdk) 1.4+ has `officialRates('sama')` and [`@allratestoday/mcp-server`](https://www.npmjs.com/package/@allratestoday/mcp-server) 0.6+ has a `get_official_rates` tool — both return this source's latest table with no key, so you can add it without a second dependency\n- Machine-readable site guide: [llms.txt](https://allratestoday.com/llms.txt) · [for-ai-agents](https://allratestoday.com/for-ai-agents/)\n\n## ⚖️ Published vs derived rates\n\nIf Saudi Central Bank (SAMA) does not print a pair directly, the API resolves it from the central bank's own table and says so — official and computed values are never confused:\n\n| `method` | `derived` | Meaning |\n| --- | --- | --- |\n| `published` | `false` | The central bank printed this pair directly |\n| `inverse` | `true` | Computed as 1 ÷ the published opposite direction |\n| `cross` | `true` | Computed via SAR from two published rates |\n\n## 🛡️ Error handling\n\nErrors are thrown as `Error` with `status` (HTTP code) and `body` (the API's JSON error) attached:\n\n```js\ntry {\n  const pair = await getRate('EUR', 'XXX', { apiKey: 'art_live_...' });\n} catch (err) {\n  console.log(err.message); // human-readable reason\n  console.log(err.status);  // e.g. 404\n}\n```\n\n| Status | Meaning |\n| ------ | ------- |\n| — | Missing `apiKey` (thrown before any request) |\n| `400` | Malformed date or parameters |\n| `401` | Invalid API key |\n| `403` | Endpoint needs a [paid plan](https://allratestoday.com/pricing/) (historical dates & series) |\n| `404` | Pair or date range not covered by Saudi Central Bank (SAMA) |\n| `429` | Monthly quota exceeded |\n\n## 🔷 TypeScript\n\nFull definitions ship with the package — no `@types` install:\n\n```ts\nimport type { LatestRates, PairRate, DatedRates, RateEntry, HistoryQuery, RequestOptions } from '@allratestoday/sama-exchange-rate';\n```\n\n## 📦 CommonJS\n\n```javascript\nconst { getRate } = require('@allratestoday/sama-exchange-rate');\n\ngetRate('EUR', 'SAR', { apiKey: 'art_live_...' }).then((pair) => console.log(pair.rate));\n```\n\n## 💡 Quota tips\n\n- Rates change once a month — cache the published table locally and a small monthly quota goes a long way.\n- Every request counts toward your AllRatesToday quota, shared across all AllRatesToday endpoints on your key.\n\n## 📖 Methods reference\n\n| Method | Plan | Description |\n| ------ | ---- | ----------- |\n| `getRate(source, target, { apiKey })` | Free | Latest rate for one pair, resolved from the published table |\n| `getLatestRates({ apiKey })` | Free | The central bank's full latest published table |\n| `getRatesForDate(date, { apiKey, source?, target? })` | Paid | The official table (or one pair) for a YYYY-MM-DD date |\n| `getHistory({ symbol \\| source+target, from?, to? }, { apiKey })` | Paid | Daily series since 2009 |\n\n## 📥 Bulk data (no key)\n\nNeed the whole archive rather than an API call? The same published tables are mirrored daily as open data:\n\n- Hugging Face: [AllRates/central-bank-exchange-rates](https://huggingface.co/datasets/AllRates/central-bank-exchange-rates) — one CSV per institution (`rates/sama.csv`)\n- Kaggle: [allratestoday/central-bank-exchange-rates](https://www.kaggle.com/datasets/allratestoday/central-bank-exchange-rates)\n- CDN JSON: `https://cdn.jsdelivr.net/gh/AllRates-Today/central-bank-exchange-rates@main/data/sama/latest.json`\n\n## 🔗 Links\n\n- [Saudi Central Bank (SAMA) rates page](https://allratestoday.com/central-bank-rates-api/sama/) — live table, publication cadence, FAQ\n- [All central bank sources](https://allratestoday.com/central-bank-rates-api/)\n- [Package docs on the site](https://allratestoday.com/docs/sdk/sama-exchange-rate/) · [ERP integration guides](https://allratestoday.com/docs/integrations/)\n- [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/) · [Methodology](https://allratestoday.com/official-rates-methodology/)\n- [Register (free)](https://allratestoday.com/register) · [Pricing](https://allratestoday.com/pricing/)\n- [GitHub](https://github.com/AllRates-Today/sama-exchange-rate)\n\n## 📜 License\n\nMIT\n","readmeFilename":"README.md"}