Skip to content

ApiUtils

QuantConnect.Api.ApiUtils

Bases: Object

API utility methods

create_json_post_request

create_json_post_request(
    endpoint: str,
    payload: Any = None,
    json_serializer_settings: Any = None,
) -> Any

Creates a POST HttpRequestMessage with the specified endpoint and payload as json body

Parameters:

Name Type Description Default
endpoint str

The request endpoint

required
payload Any

The request payload

None
json_serializer_settings Any

Settings for the json serializer

None

Returns:

Type Description
Any

The POST request.

create_post_request

create_post_request(
    endpoint: str,
    payload: List[KeyValuePair[str, str]] = None,
) -> Any

Creates a POST HttpRequestMessage with the specified endpoint and payload as form url encoded content.

Parameters:

Name Type Description Default
endpoint str

The request endpoint

required
payload List[KeyValuePair[str, str]]

The request payload

None

Returns:

Type Description
Any

The POST request.