P2P Advert List (p2p_advert_list)¶
Returns available adverts for use with p2p_order_create .
Auth Scope(s): payments
-
p2p_advert_list(advertiser_id: Optional[str] = None, advertiser_name: Optional[str] = None, amount: Optional[Union[int, float, Decimal]] = None, counterparty_type: Optional[str] = None, favourites_only: Optional[int] = None, limit: Optional[int] = None, local_currency: Optional[str] = None, offset: Optional[int] = None, payment_method: Optional[List] = None, sort_by: Optional[str] = None, use_client_limits: Optional[int] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶ Parameters: - advertiser_id (Optional[str]) – [Optional] ID of the advertiser to list adverts for.
- advertiser_name (Optional[str]) – [Optional] Search for advertiser by name. Partial matches will be returned.
- amount (Optional[Union[int, float, Decimal]]) – [Optional] How much to buy or sell, used to calculate prices.
- counterparty_type (Optional[str]) – [Optional] Filter the adverts by counterparty_type.
- favourites_only (Optional[int]) – [Optional] Only show adverts from favourite advertisers. Default is 0.
- limit (Optional[int]) – [Optional] Used for paging.
- local_currency (Optional[str]) – [Optional] Currency to conduct payment transaction in, defaults to the main currency for the client’s country.
- offset (Optional[int]) – [Optional] Used for paging.
- payment_method (Optional[List]) – [Optional] Search by supported payment methods.
- sort_by (Optional[str]) – [Optional] How the results are sorted.
- use_client_limits (Optional[int]) – [Optional] If set to 1, ads that exceed this account’s balance or turnover limits will not be shown.
- 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