Skip to content

Latest commit

 

History

History
117 lines (82 loc) · 3.63 KB

PeersApi.md

File metadata and controls

117 lines (82 loc) · 3.63 KB
Raw

hoprd_sdk.PeersApi

All URIs are relative to /

Method HTTP request Description
ping_peer POST /api/v3/peers/{peerId}/ping Directly pings the given peer.
show_peer_info GET /api/v3/peers/{peerId} Returns transport-related information about the given peer.

ping_peer

PingResponse ping_peer(peer_id)

Directly pings the given peer.

Directly pings the given peer.

Example

from __future__ import print_function
import time
import hoprd_sdk
from hoprd_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_token
configuration = hoprd_sdk.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = hoprd_sdk.PeersApi(hoprd_sdk.ApiClient(configuration))
peer_id = 'peer_id_example' # str | PeerID of the requested peer

try:
    # Directly pings the given peer.
    api_response = api_instance.ping_peer(peer_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeersApi->ping_peer: %s\n" % e)

Parameters

Name Type Description Notes
peer_id str PeerID of the requested peer

Return type

PingResponse

Authorization

api_token, bearer_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

show_peer_info

NodePeerInfoResponse show_peer_info(peer_id)

Returns transport-related information about the given peer.

Returns transport-related information about the given peer. This includes the peer ids that the given peer has announced on-chain and peer ids that are actually observed by the transport layer.

Example

from __future__ import print_function
import time
import hoprd_sdk
from hoprd_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_token
configuration = hoprd_sdk.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = hoprd_sdk.PeersApi(hoprd_sdk.ApiClient(configuration))
peer_id = 'peer_id_example' # str | PeerID of the requested peer

try:
    # Returns transport-related information about the given peer.
    api_response = api_instance.show_peer_info(peer_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeersApi->show_peer_info: %s\n" % e)

Parameters

Name Type Description Notes
peer_id str PeerID of the requested peer

Return type

NodePeerInfoResponse

Authorization

api_token, bearer_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]