Jump to
Ctrl
+
/

List Blockchain Events Subscriptions

GET
/blockchain-events/{blockchain}/{network}/subscriptions

Through this endpoint the customer can obtain a list of their callback subscriptions for the available Blockchain events.

Currently Crypto APIs 2.0 offers certain Blockchain event endpoints which allow the user to subscribe for one/a few/all and receive callback notifications when the specific event occurs.

To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks here.

Path Parameters

blockchain string Required

Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

network string Required

Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while network like "testnet" is a test network.

Query Parameters

context string Optional

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

limit integer Optional

Defines how many items should be returned in the response per page basis.

Default : 50
offset integer Optional

The starting index of the response items, i.e. where the response should start listing the returned items.

Default : 0

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2021-03-20
requestId string Required

Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

601c1710034ed6d407996b30
context string Optional

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

yourExampleString
data object Required
limit integer Required

Defines how many items should be returned in the response per page basis.

50
offset integer Required

The starting index of the response items, i.e. where the response should start listing the returned items.

0
total integer Required

Defines the total number of items returned in the response.

100
items array Items (object) Required
address string Required

Represents the address of the transaction.

tb1qtm44m6xmuasy4sc7nl7thvuxcerau2dfvkkgsc
callbackSecretKey string Optional

Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our Documentation.

yourSecretKey
callbackUrl string Required

Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. We support ONLY httpS type of protocol.

https://example.com
confirmationsCount integer Required

Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.

5
createdTimestamp integer Required

Defines the specific time/date when the subscription was created in Unix Timestamp.

1966238648
deactivationReasons array Items (object) Optional

Represents the deactivation reason details, available when a blockchain event subscription has status isActive - false.

reason string Required

Defines the deactivation reason as a message.

maximum_retry_attempts_reached
timestamp integer Required

Represents the time of the subscription deactivation.

1642102581
eventType string Required

Defines the type of the specific event available for the customer to subscribe to for callback notification.

BLOCK_MINED
isActive boolean Required

Defines whether the subscription is active or not. Set as boolean.

true
referenceId string Required

Represents a unique ID used to reference the specific callback subscription.

bc243c86-0902-4386-b30d-e6b30fa1f2aa
transactionId string Optional

Represents the unique identification string that defines the transaction.

742b4a8d54a663d372fa16abf74093595ae6fc950f2fa2bb7388c7f4d061d7b8

Credits Cost : 100 Credits for 1 Results

Was this page helpful?
Yes
No
Language
URL

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "limit": 50,
        "offset": 0,
        "total": 100,
        "items": [
            {
                "address": "tb1qtm44m6xmuasy4sc7nl7thvuxcerau2dfvkkgsc",
                "callbackSecretKey": "yourSecretKey",
                "callbackUrl": "https://example.com",
                "confirmationsCount": 5,
                "createdTimestamp": 1966238648,
                "deactivationReasons": [
                    {
                        "reason": "maximum_retry_attempts_reached",
                        "timestamp": 1642102581
                    }
                ],
                "eventType": "BLOCK_MINED",
                "isActive": true,
                "referenceId": "bc243c86-0902-4386-b30d-e6b30fa1f2aa",
                "transactionId": "742b4a8d54a663d372fa16abf74093595ae6fc950f2fa2bb7388c7f4d061d7b8"
            }
        ]
    }
}