EBS Risk Management API - Get Firm Status

Retrieve tradable status of firm

URL

/firmStatus/{fid}

HTTP Method

GET

Version

1.0.6

Content

Request

Parameters

Parameter

Name

Location

Type

Multi-ple

Values

Usage

Description

Parameter

Name

Location

Type

Multi-ple

Values

Usage

Description

fid

Firm ID (GFID)

Path

String

No



REQUIRED

The Firm identifier of the firm you want the status of

Response - 200

Body

Firm Status - FirmStatus

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

firm

Firm ID

String



ALWAYS

The Firm identifier of the firm you want the status of

killEvent

Kill Event

String



CONDITIONAL

If the firm is killed the way in which it was killed Directly or indirectly by a Firm or the Exchange itself

tradable

Tradable

String

  • N

  • Y

ALWAYS

If the the firm can trade or not

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.