Configuration

Get trading configuration by key

Retrieves a specific configuration value by its key. Note: This endpoint may be deprecated in a future release.

get/api-regulated/v1/trading-configs/{key}

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/trading-configs/{key}
  • Auth: HTTP bearer

Path parameters

keystring required

Configuration key

Response

Configuration retrieved

namestring

Configuration key identifier

configType'BIGDECIMAL' | 'STRING' | 'INTEGER' | 'BOOLEAN' | 'JSON'

Type of the configuration value

configDefaultstring

Default value from application configuration

descriptionstring

Human-readable description of this configuration

allowedRolesstring

Comma-separated list of roles allowed to access this configuration

globalOnlyboolean

True when the setting is a property of the platform rather than of a PSP relationship, and so can never be overridden for a single regulated entity

valuestring

The value in force for the requested scope

regulatedEntityIdstring uuid

Regulated entity this value was read from. Null when it is the platform-wide default.

source'GLOBAL' | 'OVERRIDE'

Whether the value is this entity's own override or the inherited platform default

versionNumberinteger

Version number of the value row

updatedBystring

Username of the person or entity that last updated the value

updatedAtstring

Timestamp of the last update in UTC

createdAtstring

Timestamp of creation in UTC

Example response

{
  "name": "currencyguard.trading.margin-rate",
  "configType": "BIGDECIMAL",
  "configDefault": "0.007",
  "allowedRoles": "REST_INTERNAL",
  "value": "0.0055",
  "regulatedEntityId": "9e107d9d-372d-4add-ae2d-f3d1d41fd1d7",
  "source": "GLOBAL",
  "versionNumber": 1,
  "updatedAt": "2024-10-18T12:30:40Z",
  "createdAt": "2024-10-18T12:30:40Z"
}

Changes

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