Market Data

FX Rate

We have a growing international institutional customer base. When pulling market data for charting, it can be useful to have access to our FX rate for the relevant currency at that time.

Please note, Gemini does not offer foreign exchange services. This endpoint is for historical reference only and does not provide any guarantee of future exchange rates.

Roles
The API key you use to access this endpoint must have the Auditor role assigned. See Roles for more information.

Supported Pairs

[AUDUSD, CADUSD, COPUSD, EURUSD, CHFUSD, HKDUSD, NZDUSD, GBPUSD, BRLUSD, INRUSD, SGDUSD, KRWUSD, JPYUSD, CNYUSD]

get/v2/fxrate/{symbol}/{timestamp}

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v2/fxrate/{symbol}/{timestamp}
  • Auth
    API key in header X-GEMINI-APIKEY and API key in header X-GEMINI-SIGNATURE and API key in header X-GEMINI-PAYLOAD

Path parameters

symbolstring required

Trading pair symbol <br /> <br />

BTCUSD, etc. See <u>symbols and minimums</u>.

string required

Gemini strongly recommends using milliseconds instead of seconds for timestamps.

Timestamp formatExampleSupported request type
string (seconds)1495127793POST only
string (milliseconds)1495127793000POST only
OR
integer required

Gemini strongly recommends using milliseconds instead of seconds for timestamps.

Timestamp formatExampleSupported request type
whole number (seconds)1495127793GET, POST
whole number (milliseconds)1495127793000GET, POST
Example:1495127793000

The timestamp to pull the FX rate for.

Gemini strongly recommends using milliseconds instead of seconds for timestamps.

Headers

X-GEMINI-APIKEYstring required

Your API key

X-GEMINI-SIGNATUREstring required

HEX-encoded HMAC-SHA384 of payload signed with API secret

X-GEMINI-PAYLOADstring required

Base64-encoded JSON payload

Content-Typestring
Content-Lengthstring
Cache-Controlstring

Response

Successful operation

fxPairstring

The requested currency pair

ratenumber double

The exchange rate

providerstring

The market data provider

benchmarkstring

The market for which the retrieved price applies to

Example response

{
  "fxPair": "AUDUSD",
  "rate": 0.69,
  "asOf": "1495127793000",
  "provider": "bcb",
  "benchmark": "Spot"
}

Changes

No recorded changes to this operation across all 1 revision of this API.