python

aces-listener-api

API Specification for ACES Listeners that read data on a blockchain and forward transaction events to registered subscribers.

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import com.arkaces.aces_listener_api 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import com.arkaces.aces_listener_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import com.arkaces.aces_listener_api
from com.arkaces.aces_listener_api.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
com.arkaces.aces_listener_api.configuration.username = 'YOUR_USERNAME'
com.arkaces.aces_listener_api.configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = com.arkaces.aces_listener_api.AcesListenerApi()

try:
    # Get Health of node.
    api_response = api_instance.status_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AcesListenerApi->status_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost/v1

Class	Method	HTTP request	Description
AcesListenerApi	status_get	GET /status	Get Health of node.
AcesListenerApi	subscriptions_id_events_get	GET /subscriptions/{id}/events	List Subscription Events
AcesListenerApi	subscriptions_id_get	GET /subscriptions/{id}	Gets Subscription
AcesListenerApi	subscriptions_id_unsubscribes_post	POST /subscriptions/{id}/unsubscribes	Create an Unsubscription.
AcesListenerApi	subscriptions_post	POST /subscriptions	Registers a subscriber node to receive blockchain events.

Documentation For Models

• FieldError
• Health
• InlineResponse200
• NotFoundError
• Subscription
• SubscriptionEvent
• SubscriptionRequest
• SubscriptionUnsubscribe
• ValidationError

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication

Author