> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# finage-forex

> Finage Forex - real-time quotes, aggregates, and currency conversion

**Server path:** `/finage-forex` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                          | Description                    |
| ----------------------------------------------------------------------------- | ------------------------------ |
| [`finage_forex_convert_forex_currency`](#finage_forex_convert_forex_currency) | Convert between currencies     |
| [`finage_forex_get_aggregates`](#finage_forex_get_aggregates)                 | Get forex OHLCV aggregate bars |
| [`finage_forex_get_last_quote`](#finage_forex_get_last_quote)                 | Get last forex quote           |
| [`finage_forex_get_previous_close`](#finage_forex_get_previous_close)         | Get forex previous close       |

***

## finage\_forex\_convert\_forex\_currency

Convert between currencies

**Parameters:**

| Parameter | Type   | Required | Default | Description                               |
| --------- | ------ | -------- | ------- | ----------------------------------------- |
| `from`    | string | Yes      | —       | Source currency code (e.g. GBP, EUR, USD) |
| `to`      | string | Yes      | —       | Target currency code (e.g. USD, EUR)      |
| `amount`  | number | Yes      | —       | Amount to convert                         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "from": {
        "type": "string",
        "description": "Source currency code (e.g. GBP, EUR, USD)"
      },
      "to": {
        "type": "string",
        "description": "Target currency code (e.g. USD, EUR)"
      },
      "amount": {
        "type": "number",
        "description": "Amount to convert"
      }
    },
    "required": [
      "PCID",
      "from",
      "to",
      "amount"
    ]
  }
  ```
</Expandable>

***

## finage\_forex\_get\_aggregates

Get forex OHLCV aggregate bars

**Parameters:**

| Parameter    | Type    | Required | Default | Description                                  |
| ------------ | ------- | -------- | ------- | -------------------------------------------- |
| `symbol`     | string  | Yes      | —       | Forex pair symbol (e.g. GBPUSD)              |
| `multiplier` | integer | Yes      | —       | Time multiplier (e.g. 1, 5, 15)              |
| `timespan`   | string  | Yes      | —       | Time unit: minute, hour, day, week, or month |
| `from`       | string  | Yes      | —       | Start date in YYYY-MM-DD format              |
| `to`         | string  | Yes      | —       | End date in YYYY-MM-DD format                |
| `limit`      | integer | No       | —       | Maximum number of results                    |
| `sort`       | string  | No       | —       | Sort order by timestamp: asc or desc         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "symbol": {
        "type": "string",
        "description": "Forex pair symbol (e.g. GBPUSD)"
      },
      "multiplier": {
        "type": "integer",
        "description": "Time multiplier (e.g. 1, 5, 15)"
      },
      "timespan": {
        "type": "string",
        "description": "Time unit: minute, hour, day, week, or month",
        "enum": [
          "minute",
          "hour",
          "day",
          "week",
          "month"
        ]
      },
      "from": {
        "type": "string",
        "description": "Start date in YYYY-MM-DD format"
      },
      "to": {
        "type": "string",
        "description": "End date in YYYY-MM-DD format"
      },
      "limit": {
        "type": "integer",
        "description": "Maximum number of results"
      },
      "sort": {
        "type": "string",
        "description": "Sort order by timestamp: asc or desc",
        "enum": [
          "asc",
          "desc"
        ]
      }
    },
    "required": [
      "PCID",
      "symbol",
      "multiplier",
      "timespan",
      "from",
      "to"
    ]
  }
  ```
</Expandable>

***

## finage\_forex\_get\_last\_quote

Get last forex quote

**Parameters:**

| Parameter | Type   | Required | Default | Description                             |
| --------- | ------ | -------- | ------- | --------------------------------------- |
| `symbol`  | string | Yes      | —       | Forex pair symbol (e.g. GBPUSD, EURUSD) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "symbol": {
        "type": "string",
        "description": "Forex pair symbol (e.g. GBPUSD, EURUSD)"
      }
    },
    "required": [
      "PCID",
      "symbol"
    ]
  }
  ```
</Expandable>

***

## finage\_forex\_get\_previous\_close

Get forex previous close

**Parameters:**

| Parameter | Type   | Required | Default | Description                     |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `symbol`  | string | Yes      | —       | Forex pair symbol (e.g. GBPUSD) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "symbol": {
        "type": "string",
        "description": "Forex pair symbol (e.g. GBPUSD)"
      }
    },
    "required": [
      "PCID",
      "symbol"
    ]
  }
  ```
</Expandable>