Costfluent Public API

Get available currencies

GET
https://api.costfluent.com
/v1/exchange-rates/currencies
Bearer (API token)

Returns the ISO 4217 codes of the currencies exchange rates are published for.

Needs any valid token.

Get available currencies › query Parameters

page
​integer · int32

The page to return, counted from 1. A page below 1 reads page 1; one past the last returns no items.

Default: 1
limit
​integer · int32

Items per page, from 1 to 100. A larger value is clamped to 100, a smaller one to 1.

Default: 20

Get available currencies › Responses

Success

​PaginationLinks · required
data
​string[] · required

Get exchange rate

GET
https://api.costfluent.com
/v1/exchange-rates/rate
Bearer (API token)

Returns the rate for a currency pair from the last ECB publication on or before date, named in effectiveDate; the latest publication when date is omitted or later. Every pair derives through the euro, so inverse and cross pairs are computed from the euro rates.

Needs any valid token.

Get exchange rate › query Parameters

baseCurrency
​string · pattern: ^[A-Z]{3}$ · required
targetCurrency
​string · pattern: ^[A-Z]{3}$ · required
date
​string | null · date

Get exchange rate › Responses

Success

baseCurrency
​string · pattern: ^[A-Z]{3}$ · required
targetCurrency
​string · pattern: ^[A-Z]{3}$ · required
rate
​number · double · required
effectiveDate
​string · date · required
source
​string · required

Get the workspace's exchange rate policy

GET
https://api.costfluent.com
/v1/workspaces/{workspaceId}/exchange-rates/policy
Bearer (API token)

The conversion method, the named rate source, and the period the policy applies to. Read-only: the policy is an accounting decision recorded with the account, not a setting.

Needs a token with viewCosts on the workspace.

Get the workspace's exchange rate policy › path Parameters

workspaceId
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

Get the workspace's exchange rate policy › Responses

Success

available
​boolean · required
​required
​FxPolicyResponse[] · required

List exchange rates

GET
https://api.costfluent.com
/v1/exchange-rates
Bearer (API token)

Returns the published exchange rates over a window of publication days, paged; the window defaults to the latest publication day.

Needs any valid token.

List exchange rates › query Parameters

startDate
​string | null · date

The first publication day listed, included. Defaults to the latest publication day, or to endDate when that is earlier.

endDate
​string | null · date

The last publication day listed, included. Defaults to the latest publication day.

baseCurrency
​string | null · pattern: ^[A-Z]{3}$
targetCurrency
​string | null · pattern: ^[A-Z]{3}$
page
​integer · int32

The page to return, counted from 1. A page below 1 reads page 1; one past the last returns no items.

Default: 1
limit
​integer · int32

Items per page, from 1 to 100. A larger value is clamped to 100, a smaller one to 1.

Default: 20

List exchange rates › Responses

Success