States List (states_list)

For a given country, returns a list of States of that country. This is useful to populate the account opening form.

states_list(states_list: str, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • states_list (str) – Client’s 2-letter country code (obtained from residence_list call)
  • passthrough (Optional[Any]) – [Optional] Used to pass data through the websocket, which may be retrieved via the echo_req output field.
  • req_id (Optional[int]) – [Optional] Used to map request to response.
Returns:

req_id
Return type:

int

Example

binary.api.states_list(
    'id'
)

See also