Connectors

Get Connector Config Map

Changed on

Get configuration fields required for a specific connector with type information.

Args: connector_name: Name of the connector to get config map for

Returns: Dictionary mapping field names to their type information. Each field contains: - type: The expected data type (e.g., "str", "SecretStr", "int") - required: Whether the field is required - allowed_values: List of accepted values (only for Literal fields) - prompt: Human readable prompt from the Hummingbot config map (when defined)

get/connectors/{connector_name}/config-map

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/connectors/{connector_name}/config-map
  • Auth
    HTTP basic

Path parameters

connector_namestring required

Response

Successful Response

object required

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • breaking

      the response's body type changed from array to object for status