EBS Risk Management API - List Grantee Group Limits

Owned by CME Group
Apr 26, 2024
1 min read

Retrieve limits configured for a grantee group

URL

/limits/{granteeGroupId}

HTTP Method

GET

Version

1.0.5

Content

Request

Parameters

Parameter

Name

Location

Type

Multi-ple

Values

Usage

Description

Parameter

Name

Location

Type

Multi-ple

Values

Usage

Description

granteeGroupId

Grantee Group ID

Path

String

No

 

REQUIRED

Group identifier (firm short name)

Response - 200

Body

GranteeGroupLimits - GranteeGroupLimits

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

count

Count

Integer

 

ALWAYS

Number of grantee groups returned

grantorGroupId

Grantor Group ID

String

 

ALWAYS

Unique identifier of the grantor group

limits[]

Limits

Limit

 

Limit - GranteeGroupLimits.limits[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

currentLimit

Current Limit

Integer

 

ALWAYS

Current limit being enforced

dav

Daily Adjusted Value

Integer

 

ALWAYS

Daily adjusted value

defaultLimit

Default Limit

Integer

 

ALWAYS

Limit that will be enforced next day

type

Limit Type

String

  • ALL_NET

  • ALL

  • NDF

  • NDF_NET

  • SPOT

  • SPOT_NET

ALWAYS

The type of limit

availableBalance

Available Balance

Integer

 

ALWAYS

The balance remaining for the current day. Daily utilizations are included in the available balance calculation as follows:

Available Balance = Current Limit + Daily Adjusted Value - Utilizations

Response - 400

Body

Error Message - ErrorMessage

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

errors[]

Errors

Error

 

Error - ErrorMessage.errors[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

code

Code

String

  • 400

ALWAYS

 

message

Message

String

 

ALWAYS

 

referenceIndex

Reference Index

Integer

 

ALWAYS

 

 

Bad Request

 

Response - 401

 

Unauthorized

 

Response - 403

Body

Error Message - ErrorMessage

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

errors[]

Errors

Error

 

Error - ErrorMessage.errors[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

code

Code

String

  • 403

ALWAYS

 

message

Message

String

 

ALWAYS

 

referenceIndex

Reference Index

Integer

 

ALWAYS

 

 

Forbidden

 

Response - 404

 

Not Found

 

Response - 500

 

Internal Server Error

 



How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.