floq.client.api_client

This module provides an interface for communicating with Floq API service.

class floq.client.api_client.ApiClient(hostname: str, api_key: str, version: int = 1, use_ssl: bool = True)

Bases: object

Makes HTTP requests to the Floq API service.

delete(endpoint: str) → requests.models.Response

Sends DELETE request to the service.

Parameters

endpoint – API endpoint.

Returns

request.Response object.

get(endpoint: str, stream: bool = False) → requests.models.Response

Sends GET request to the service.

Parameters

• endpoint – API endpoint.

• stream – Indicates if streaming response should start.

Returns

request.Response object.

post(endpoint: str, data: Optional[str] = None) → requests.models.Response

Sends POST request to the service.

Parameters

• endpoint – API endpoint.

• data – Data to be sent to the service.

Returns

request.Response object.