Opportunity report

POST 
/v1/reports/opportunity_report

Generate an opportunity report comparing execution performance against our calculated averages.

Request

application/json

Body

array

required

• Array [

trade_id stringrequired
Trade ID for further trader search within the report.
Example: ABCD1234
timestamp date-timerequired

Date and time when this trade took place.

buy_currency stringrequired
The currency that you want to buy.
Possible values: >= 3 characters and <= 3 characters
Example: BRL
sell_currency stringrequired
The currency that you want to sell.
Possible values: >= 3 characters and <= 3 characters
Example: USD
base_amount int64required
The amount of base currency bought or sold
Example: 5000
rate double
Example: 100.00
tenor TenorREST (string)required
The tenor value for the quote e.g. SPOT, CASH (T+0), NEXT DAY (T+1)
Possible values: [SPOT, TOD, TOM]
Default value: SPOT
Example: SPOT

• ]

Responses

200

Your request has been successfully processed.

application/json

Schema

Schema

• Array [

trade_id string
Trade ID for further trader search within the report.
Example: ABCD1234
timestamp date-time

Date and time when this trade took place.

buy_currency string
The currency that you want to buy.
Possible values: >= 3 characters and <= 3 characters
Example: BRL
sell_currency string
The currency that you want to sell.
Possible values: >= 3 characters and <= 3 characters
Example: USD
base_amount int64
The amount of base currency bought or sold
Example: 5000
rate double
Example: 100.00
traded_amount double
Example: 100.00
abx_best_rate double
Example: 99.00
best_rate_source string
Example: CAB

all_rates

object[]

Array [

rate double

Example: 99.00

source string

Example: CAB

]

• ]

Example (from schema)

[
  {
    "trade_id": "ABCD1234",
    "timestamp": "2024-07-29T15:51:28.071Z",
    "buy_currency": "BRL",
    "sell_currency": "USD",
    "base_amount": "5000",
    "rate": "100.00",
    "traded_amount": "100.00",
    "abx_best_rate": "99.00",
    "best_rate_source": "CAB",
    "all_rates": [
      {
        "rate": "99.00",
        "source": "CAB"
      }
    ]
  }
]

401

Authentication token is required for this action that was not provided, expired or invalid.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

500

Internal server error.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

Loading...