Basics

General information how to start using Flash FX API

Assumptions

The examples below assume you are a verified customer of Flash FX 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:

curl -X POST 'https://api.flash-fx.com' \
-H 'authorization: Bearer YOUR_TOKEN' \
-H 'content-type: application/json' \
-d '{
"query":
"{
quote(input: {
fromCurrency: AUD, toCurrency: XRP, size: 9.9, currency: AUD
})
{
bid ask symbol timestamp inverted
}
}"
}'

All the responses are JSON and have at least one property data and optional property errors.

{
"data": { ... },
"errors": [ ... ]
}

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.