Basics
General information how to start using Flash FX API

Assumptions

The examples below assume you are a verified customer of FlashFX and have been enabled for API access.
All the GraphQL queries can be sent via the GraphQL Playground or as a HTTP POST request to https://api.flash-fx.com. Example:
1
curl -X POST 'https://api.flash-fx.com' \
2
-H 'authorization: Bearer YOUR_TOKEN' \
3
-H 'content-type: application/json' \
4
-d '{
5
"query":
6
"{
7
quote(input: {
8
fromCurrency: AUD, toCurrency: USD, size: 9.9, currency: AUD
9
})
10
{
11
bid ask symbol timestamp inverted
12
}
13
}"
14
}'
Copied!
All the responses are JSON and have at least one property data and optional property errors.
1
{
2
"data": { ... },
3
"errors": [ ... ]
4
}
Copied!

Tip

In GraphQL Playground query editor press Cmd+Space or Ctrl+Space or Opt+Space or Alt+Space or Shift+Space to show context help and possible options.
Some of the GraphQL query parameters are required, others are optional. To understand if a variable/property is required you would need to check the API schema.
  • Go to the GraphQL Playground and click the button "DOCS" on the right.
  • Browse through queries, mutations, input and output types. Find a variable/property which have an exclamation mark at the end. E.g. fromCurrency: FromCurrency!.
  • The exclamation mark denotes that the variable/property is mandatory.
Do not ever send us "N/A" or "NA" or "NULL" or "null" or "nil" or any other dummy string values in any of the API fields.
Last modified 4mo ago
Copy link