APILayer · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apilayer Endpoints API

13 actions 13 updates phrasing extends openapi/apilayer-endpoints-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for APILayer's API. It is a proposal applied on top of the contract, not a document APILayer publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/change'].get
$.paths['/timeframe'].get
$.paths['/historical'].get
$.paths['/convert'].get
$.paths['/live'].get
$.paths['/fluctuation'].get
$.paths['/timeseries'].get
$.paths['/symbols'].get
$.paths['/latest'].get
$.paths['/{date}'].get
$.paths['/{IPAddress}'].get
$.paths['/check'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Apilayer Endpoints API
  version: 1.0.0
extends: openapi/apilayer-endpoints-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/change'].get
  update:
    x-apievangelist-phrasing:
      intent: Get currency change over a period from USD
      effect: read
      questions:
      - How much has the euro moved against the dollar since yesterday's close, in margin and percent?
      - Can ExchangeRate.host tell me the percentage change of several currencies over a date range I choose?
      - What does the /change endpoint return if I leave out the start and end dates?
      instructions:
      - text: Show the margin and percentage change of {currencies} against USD since yesterday's end-of-day rates.
        slots:
          currencies: query.currencies
      - text: Get the ExchangeRate.host change values for {currencies} relative to {source} between {start_date} and {end_date}.
        slots:
          currencies: query.currencies
          source: query.source
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/timeframe'].get
  update:
    x-apievangelist-phrasing:
      intent: Get USD-based rates for each day of a time frame
      effect: read
      questions:
      - Can I pull ExchangeRate.host rates for every day across a period of up to 365 days?
      - Why does my ExchangeRate.host timeframe response get huge, and how do I limit it to a few currencies?
      - Which ExchangeRate.host endpoint gives a day-by-day rate table between two dates with a USD source?
      instructions:
      - text: Fetch ExchangeRate.host daily rates from {start_date} to {end_date} for {currencies} only.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          currencies: query.currencies
      - text: Build an ExchangeRate.host timeframe of rates quoted against {source} between {start_date} and {end_date}.
        slots:
          source: query.source
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/historical'].get
  update:
    x-apievangelist-phrasing:
      intent: Get USD-based exchange rates for a past date
      effect: read
      questions:
      - What were the dollar exchange rates on a specific day back in 2005?
      - How far back does ExchangeRate.host historical data go for a single date?
      - Is a currency like Bitcoin missing on some past days in the ExchangeRate.host historical rates?
      instructions:
      - text: Get the ExchangeRate.host historical rates for {date} against USD.
        slots:
          date: query.date
      - text: Look up ExchangeRate.host rates for {currencies} on {date} using {source} as the source currency.
        slots:
          currencies: query.currencies
          date: query.date
          source: query.source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/convert'].get
  update:
    x-apievangelist-phrasing:
      intent: Convert an amount from one currency to another
      effect: read
      questions:
      - How do I convert 250 US dollars into Japanese yen?
      - Can I convert an amount using the exchange rate from a past date instead of today's?
      - What do I need to pass to do a single currency conversion?
      instructions:
      - text: Convert {amount} {from} to {to}.
        slots:
          amount: query.amount
          from: query.from
          to: query.to
      - text: Convert {amount} from {from} to {to} at the rate that applied on {date}.
        slots:
          amount: query.amount
          from: query.from
          to: query.to
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/live'].get
  update:
    x-apievangelist-phrasing:
      intent: Get real-time exchange rates from a USD source
      effect: read
      questions:
      - What are the live ExchangeRate.host rates against the US dollar right now?
      - How often are real-time rates refreshed on the Free plan versus the Business plan?
      - Can I get live quotes with a source currency other than USD?
      instructions:
      - text: Get the live ExchangeRate.host quotes for {currencies} against USD.
        slots:
          currencies: query.currencies
      - text: Show real-time ExchangeRate.host rates with {source} as the source currency.
        slots:
          source: query.source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fluctuation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get rate fluctuation between two dates from EUR
      effect: read
      questions:
      - How much did the pound fluctuate against the euro between two dates, with start and end rates?
      - Does exchangeratesapi give the start rate, end rate and change percentage for a period?
      - Which endpoint shows fluctuation data with a EUR base by default?
      instructions:
      - text: Show the fluctuation of {symbols} against EUR from {start_date} to {end_date}.
        slots:
          symbols: query.symbols
          start_date: query.start_date
          end_date: query.end_date
      - text: Get exchangeratesapi fluctuation data with base {base} between {start_date} and {end_date}.
        slots:
          base: query.base
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/timeseries'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a daily EUR-based rate time series
      effect: read
      questions:
      - How do I get a daily time series of euro exchange rates between two dates?
      - What is the longest range I can request from the exchangeratesapi time-series endpoint?
      - Can the exchangeratesapi time series use a base currency other than EUR?
      instructions:
      - text: Get the exchangeratesapi time series for {symbols} from {start_date} to {end_date}.
        slots:
          symbols: query.symbols
          start_date: query.start_date
          end_date: query.end_date
      - text: Pull daily exchangeratesapi rates with base {base} for every day between {start_date} and {end_date}.
        slots:
          base: query.base
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/symbols'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported currency codes and names
      effect: read
      questions:
      - Which currencies are supported, with their full names?
      - What currency code should I use for the Swiss franc?
      - How do I get the full list of currency symbols the rates endpoints accept?
      instructions:
      - text: List every supported currency symbol with its full name.
      - text: Return the supported currency list wrapped in the JSONP function {callback}.
        slots:
          callback: query.callback
      method: generated
      generated: '2026-10-01'
- target: $.paths['/latest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest EUR-based exchange rates
      effect: read
      questions:
      - What are the latest exchangeratesapi rates against the euro?
      - Can I get today's exchangeratesapi rates for just a handful of currencies?
      - Is it possible to change the base of the latest exchangeratesapi rates away from EUR?
      instructions:
      - text: Get the latest exchangeratesapi rates for {symbols} against EUR.
        slots:
          symbols: query.symbols
      - text: Show the current exchangeratesapi rates with {base} as the base currency.
        slots:
          base: query.base
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get EUR-based exchange rates for a specific day
      effect: read
      questions:
      - What was the euro worth in other currencies on a particular past day?
      - How do I request exchangeratesapi rates for one date by putting the date in the path?
      - Can I set a base currency on an exchangeratesapi historical-day lookup?
      instructions:
      - text: Pull the euro-based exchangeratesapi rates that applied on the past day {date}.
        slots:
          date: path.date
      - text: Look up exchangeratesapi rates for {symbols} on {date} with base {base}.
        slots:
          symbols: query.symbols
          date: path.date
          base: query.base
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{IPAddress}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up location data for IP addresses
      effect: read
      questions:
      - Where is this IP address located?
      - Can I look up as many as 50 IP addresses in a single request?
      - Does ipapi accept a domain name and resolve it to an IP before the lookup?
      - Can an IP lookup include hostname and security threat details?
      instructions:
      - text: Look up the location of IP address {IPAddress}.
        slots:
          IPAddress: path.IPAddress
      - text: Run a bulk IP lookup for the comma-separated addresses {IPAddress} with the security module turned on.
        slots:
          IPAddress: path.IPAddress
      - text: Look up {IPAddress} and return the results in {language}.
        slots:
          IPAddress: path.IPAddress
          language: query.language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/check'].get
  update:
    x-apievangelist-phrasing:
      intent: Detect and look up the caller's own IP address
      effect: read
      questions:
      - What is my own public IP address and where does it say I am?
      - Can ipapi detect the IP that my request is coming from without me passing it?
      instructions:
      - text: Check which IP address my request is coming from and where it is located.
      - text: Detect my requesting IP and return only the {fields} fields.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-10-01'