| Method | HTTP request | Description |
|---|---|---|
| accept_quote | PUT /communications/quotes//accept | Accept Quote |
| confirm_quote | PUT /communications/quotes//confirm | Confirm Quote |
| create_quote | POST /communications/quotes | Create Quote |
| create_rfq | POST /communications/rfqs | Create RFQ |
| delete_quote | DELETE /communications/quotes/ | Delete Quote |
| delete_rfq | DELETE /communications/rfqs/ | Delete RFQ |
| get_communications_id | GET /communications/id | Get Communications ID |
| get_quote | GET /communications/quotes/ | Get Quote |
| get_quotes | GET /communications/quotes | Get Quotes |
| get_rfq | GET /communications/rfqs/ | Get RFQ |
| get_rfqs | GET /communications/rfqs | Get RFQs |
accept_quote
accept_quote(quote_id, accept_quote_request)Accept Quote Endpoint for accepting a quote. This will require the quoter to confirm
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| quote_id | str | Quote ID | |
| accept_quote_request | AcceptQuoteRequest |
Return type
void (empty response body)HTTP response details
| Status code | Description |
|---|---|
| 204 | Quote accepted successfully |
| 400 | Bad request - invalid input |
| 401 | Unauthorized - authentication required |
| 404 | Resource not found |
| 500 | Internal server error |
confirm_quote
confirm_quote(quote_id, body=body)Confirm Quote Endpoint for confirming a quote. This will start a timer for order execution
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| quote_id | str | Quote ID | |
| body | object | [optional] |
Return type
void (empty response body)HTTP response details
| Status code | Description |
|---|---|
| 204 | Quote confirmed successfully |
| 401 | Unauthorized - authentication required |
| 404 | Resource not found |
| 500 | Internal server error |
create_quote
CreateQuoteResponse create_quote(create_quote_request)Create Quote Endpoint for creating a quote in response to an RFQ
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| create_quote_request | CreateQuoteRequest |
Return type
CreateQuoteResponseHTTP response details
| Status code | Description |
|---|---|
| 201 | Quote created successfully |
| 400 | Bad request - invalid input |
| 401 | Unauthorized - authentication required |
| 500 | Internal server error |
create_rfq
CreateRFQResponse create_rfq(create_rfq_request)Create RFQ Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| create_rfq_request | CreateRFQRequest |
Return type
CreateRFQResponseHTTP response details
| Status code | Description |
|---|---|
| 201 | RFQ created successfully |
| 400 | Bad request - invalid input |
| 401 | Unauthorized - authentication required |
| 409 | Conflict - resource already exists or cannot be modified |
| 500 | Internal server error |
delete_quote
delete_quote(quote_id)Delete Quote Endpoint for deleting a quote, which means it can no longer be accepted.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| quote_id | str | Quote ID |
Return type
void (empty response body)HTTP response details
| Status code | Description |
|---|---|
| 204 | Quote deleted successfully |
| 401 | Unauthorized - authentication required |
| 404 | Resource not found |
| 500 | Internal server error |
delete_rfq
delete_rfq(rfq_id)Delete RFQ Endpoint for deleting an RFQ by ID
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| rfq_id | str | RFQ ID |
Return type
void (empty response body)HTTP response details
| Status code | Description |
|---|---|
| 204 | RFQ deleted successfully |
| 401 | Unauthorized - authentication required |
| 404 | Resource not found |
| 500 | Internal server error |
get_communications_id
GetCommunicationsIDResponse get_communications_id()Get Communications ID Endpoint for getting the communications ID of the logged-in user.
Parameters
This endpoint does not need any parameter.Return type
GetCommunicationsIDResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | Communications ID retrieved successfully |
| 401 | Unauthorized - authentication required |
| 500 | Internal server error |
get_quote
GetQuoteResponse get_quote(quote_id)Get Quote Endpoint for getting a particular quote
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| quote_id | str | Quote ID |
Return type
GetQuoteResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | Quote retrieved successfully |
| 401 | Unauthorized - authentication required |
| 404 | Resource not found |
| 500 | Internal server error |
get_quotes
GetQuotesResponse get_quotes(cursor=cursor, event_ticker=event_ticker, market_ticker=market_ticker, limit=limit, status=status, quote_creator_user_id=quote_creator_user_id, rfq_creator_user_id=rfq_creator_user_id, rfq_creator_subtrader_id=rfq_creator_subtrader_id, rfq_id=rfq_id)Get Quotes Endpoint for getting quotes
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cursor | str | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | [optional] |
| event_ticker | str | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | [optional] |
| market_ticker | str | Filter by market ticker | [optional] |
| limit | int | Parameter to specify the number of results per page. Defaults to 500. | [optional] [default to 500] |
| status | str | Filter quotes by status | [optional] |
| quote_creator_user_id | str | Filter quotes by quote creator user ID | [optional] |
| rfq_creator_user_id | str | Filter quotes by RFQ creator user ID | [optional] |
| rfq_creator_subtrader_id | str | Filter quotes by RFQ creator subtrader ID (FCM members only) | [optional] |
| rfq_id | str | Filter quotes by RFQ ID | [optional] |
Return type
GetQuotesResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | Quotes retrieved successfully |
| 401 | Unauthorized - authentication required |
| 500 | Internal server error |
get_rfq
GetRFQResponse get_rfq(rfq_id)Get RFQ Endpoint for getting a single RFQ by id
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| rfq_id | str | RFQ ID |
Return type
GetRFQResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | RFQ retrieved successfully |
| 401 | Unauthorized - authentication required |
| 404 | Resource not found |
| 500 | Internal server error |
get_rfqs
GetRFQsResponse get_rfqs(cursor=cursor, event_ticker=event_ticker, market_ticker=market_ticker, limit=limit, status=status, creator_user_id=creator_user_id)Get RFQs Endpoint for getting RFQs
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cursor | str | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | [optional] |
| event_ticker | str | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | [optional] |
| market_ticker | str | Filter by market ticker | [optional] |
| limit | int | Parameter to specify the number of results per page. Defaults to 100. | [optional] [default to 100] |
| status | str | Filter RFQs by status | [optional] |
| creator_user_id | str | Filter RFQs by creator user ID | [optional] |
Return type
GetRFQsResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | RFQs retrieved successfully |
| 401 | Unauthorized - authentication required |
| 500 | Internal server error |