> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# ConversionRate

# Package: stores

# Namespace: CurrencyConverter

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/currency-converter/get-conversion-rate.md

## Permission Scopes:
Manage Currencies: SCOPE.DC-CURRENCY-CONVERTER.MANAGE-CURRENCIES

## Introduction

Returns the conversion rate between 2 currencies.

---

## REST API

### Schema

```
 Method: conversionRate
 Description: Returns the conversion rate between 2 currencies.
 URL: https://www.wixapis.com/v1/currencies/rate/{from}/convert/{to}
 Method: GET
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  from, to
 Method parameters: 
   param name: from | type:   none | required: true
   param name: to | type:   none | required: true
 Return type: ConversionRateResponse
  - name: rate | type: DecimalValue | description: Conversion rate between 2 currencies. 
     - name: value | type: string | description: Value without decimals (e.g., for 10.95 value will be 1095). 
     - name: decimalPlaces | type: integer | description: Decimal places to apply (e.g., for 10.95 decimal_places will be 2). 
  - name: rateTimestamp | type: string | description: Date and time the conversion rate was last updated. 


```

### Examples

### ConversionRate
```curl
~~~cURL
curl 'https://www.wixapis.com/currency_converter/v1/currencies/rate/USD/convert/EUR' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
~~~
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.stores.CurrencyConverter.conversionRate(identifiers)
 Description: Returns the conversion rate between 2 currencies.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  identifiers.from, identifiers.to, identifiers
 Method parameters: 
   param name: identifiers | type: ConversionRateIdentifiers  none | required: true
        - name: from | type: string | description: Original currency. | required: true
        - name: to | type: string | description: Target currency. | required: true
 Return type: PROMISE<ConversionRateResponse>
  - name: rate | type: DecimalValue | description: Conversion rate between 2 currencies. 
     - name: value | type: string | description: Value without decimals (e.g., for 10.95 value will be 1095). 
     - name: decimalPlaces | type: integer | description: Decimal places to apply (e.g., for 10.95 decimal_places will be 2). 
  - name: rateTimestamp | type: Date | description: Date and time the conversion rate was last updated. 


```

### Examples

### Return the conversion rate and timestamp (with elevated permissions)
```javascript
import { currencies } from '@wix/ecom';
import { auth } from '@wix/essentials';

const elevatedGetConversionRate = auth.elevate(currencies.getConversionRate);

elevatedGetConversionRate({from: 'USD', to: 'GBP'})
  .then((conversionRate) => {
    const rate = conversionRate.rate;
    const timestamp = conversionRate.rateTimestamp;
  });

/* Promise resolves to:
 *  {
 *    "rate": {
 *       value: "20",
 *       decimalPlaces: 2
 *    },
 *    "rateTimestamp": "2020-03-15T20:00:00.181Z"
 *  }
 */

```

### Return the conversion rate and timestamp
```javascript
import { currencies } from '@wix/ecom';
  
currencies.getConversionRate({from: 'USD', to: 'GBP'})
  .then((conversionRate) => {
    const rate = conversionRate.rate;
    const timestamp = conversionRate.rateTimestamp;
  });

/* Promise resolves to:
 *  {
 *    "rate": {
 *       value: "20",
 *       decimalPlaces: 2
 *    },
 *    "rateTimestamp": "2020-03-15T20:00:00.181Z"
 *  }
 */
```

### getConversionRate (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { currencies } from '@wix/ecom';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { currencies },
  // Include the auth strategy and host as relevant
});


async function getConversionRate(identifiers) {
  const response = await myWixClient.currencies.getConversionRate(identifiers);
};
```

---