P2P Advertiser Create (p2p_advertiser_create)

Registers the client as a P2P advertiser.

Auth Scope(s): payments

p2p_advertiser_create(name: str, contact_info: Optional[str] = None, default_advert_description: Optional[str] = None, payment_info: Optional[str] = None, subscribe: Optional[Union[bool, int]] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • name (str) – The advertiser’s displayed name.
  • contact_info (Optional[str]) – [Optional] Advertiser’s contact information, to be used as a default for new sell adverts.
  • default_advert_description (Optional[str]) – [Optional] Default description that can be used every time an advert is created.
  • payment_info (Optional[str]) – [Optional] Advertiser’s payment information, to be used as a default for new sell adverts.
  • subscribe (Optional[Union[bool, int]]) – [Optional] If set to 1, will send updates whenever there is an update to advertiser
  • 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.p2p_advertiser_create(
    name='your_name'
)

See also