Skip to main content

Methods

Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it.

Key Features​

  • Purpose & Overview: Explains the purpose of the method and its role in the API.
  • Parameters: Describe the required input parameters, including their data types.
  • Response Format: Details the expected return format or structure.
  • Error Scenarios: Outline potential errors or issues that may arise during method execution.
  • Example: Provides a sample of how the API uses the method.

Available Methods​

This is a list of the core methods available in the Python SDK for V1 endpoints: