New confirmed coins transactions and each confirmation

Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when there are new incoming or outgoing confirmed transactions for coins from/to the customer's address with also a response at each confirmation the transaction has received until the specified confirmations limit is reached. By creating this subscription the user will be notified by Crypto APIs 2.0 when that event occurs. The information is returned per specified address.

Being confirmed means that the transactions are verified by miners and added to the next block. This endpoint refers to coins transactions only, not tokens.

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

Crypto APIs will notify the user only when the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification will not be sent if the event does not or cannot occur, or will take long time to occur.

POST /blockchain-events/{blockchain}/{network}/subscriptions/address-coins-transactions-confirmed-each-confirmation

Path Parameters

  • Required
    blockchain string

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

    Example : bitcoin
  • Required
    network string

    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 networks like "testnet", "ropsten", "rinkeby" are test networks.

    Example : testnet

Request body schema application/json

  • Optional
    context string

    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.

  • Required
    data object
    • Required
      item object
      • Required
        address string

        Represents the address of the transaction, per which the result is returned.

        Example : mho4jHBcrNCncKt38trJahXakuaBnS7LK5
      • Optional
        allowDuplicates boolean

        Specifies a flag that permits or denies the creation of duplicate addresses.

        Default : False
        Example : True
      • Optional
        callbackSecretKey string

        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.

        Example : yourSecretKey
      • Required
        callbackUrl string

        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.

        Example : http://example.com
      • Required
        confirmationsCount integer

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

        Example : 3

Response schema

201 400 401 402 403 409 415 422 429 500
HTTP Status Code: 201
Content-Type: application/json

The resource has been successfully created.

  • Object :

  • Required
    apiVersion string

    Specifies the version of the API that incorporates this endpoint.

    Example : 2.0
  • Required
    requestId string

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

    Example : 601c1710034ed6d407996b30
  • Optional
    context string

    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.

    Example : You can add any text here
  • Required
    data object
    • Required
      item object
      • Required
        address string

        Represents the address of the transaction, per which the result is returned.

        Example : 15XyNC88pujwuuur8DCsXBCfEhJJMzHayU
      • Required
        callbackSecretKey string

        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.

        Example : yourSecretKey
      • Required
        callbackUrl string

        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.

        Example : https://example.com
      • Required
        confirmationsCount integer

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

        Example : 2
      • Required
        createdTimestamp integer

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

        Example : 1611238648
      • Required
        eventType string

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

        Example : ADDRESS_COINS_TRANSACTION_CONFIRMED_EACH_CONFIRMATION
      • Required
        isActive boolean

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

        Example : True
      • Required
        referenceId string

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

        Example : bc243c86-0902-4386-b30d-e6b30fa1f2aa
      • Required
        transactionId string

        Represents the unique identification string that defines the transaction.

        Example : 96b4ea92dcca3a046c0ca2738ed9400f3c04f6c5f497cce4f3a148b1c948a1b3

Callback parameters Method : POST

ADDRESS_COINS_TRANSACTION_CONFIRMED_EACH_CONFIRMATION

Content-Type : application/json

  • Object :

  • Required
    apiVersion string

    Specifies the version of the API that incorporates this endpoint.

    Example : 2.0
  • Required
    referenceId string

    Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.

    Example : 6038d09050653d1f0e40584c
  • Required
    idempotencyKey string

    Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.

    Example : e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c
  • Required
    data object

    Specifies all data, as attributes, included into the callback notification, which depends on the event.

    • Required
      product string

      Represents the Crypto APIs 2.0 product which sends the callback.

      Example : Blockchain Events
    • Required
      event string

      Defines the specific event, for which a callback subscription is set.

      Example : ADDRESS_COINS_TRANSACTION_CONFIRMED_EACH_CONFIRMATION
    • Required
      item object

      Defines an item as one result.

      • Required
        blockchain string

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

        Example : bitcoin
      • Required
        network string

        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 networks like "testnet", "ropsten", "rinkeby" are test networks.

        Example : testnet
      • Required
        address string

        Defines the specific address to which the transaction has been sent.

        Example : 15282N4BYEwYh3j1dTgJu64Ey5qWn9Po9F
      • Required
        minedInBlock object

        Refers to the specific block the transaction was mined in.

        • Required
          height integer

          Defines the number of blocks in the blockchain preceding this specific block.

          Example : 667754
        • Required
          hash string

          Represents the hash of the block's header, i.e. an output that has a fixed length.

          Example : dfe45f6724b550c281107ffaa5880cb280878fb4dbaa742aa21449f3d2340c13
        • Required
          timestamp integer

          Defines the exact date/time when this transaction was mined in seconds since Unix Epoch time.

          Example : 1610365314
      • Required
        transactionId string

        Defines the unique ID of the specific transaction, i.e. its identification number.

        Example : cbd3dea703bd2bc78bca69ee61ca14e6ffcdd809d07ebbc3b8fea3c30ea38f33
      • Required
        currentConfirmations integer

        Defines the number of currently received confirmations for the transaction.

        Example : 8
      • Required
        targetConfirmations integer

        Defines the number of confirmation transactions requested as callbacks, i.e. the system can notify till the n-th confirmation.

        Example : 12
      • Required
        amount string

        Defines the amount of coins sent with the confirmed transaction.

        Example : 0.0611
      • Required
        unit string

        Defines the unit of the transaction, e.g. BTC.

        Example : BTC
      • Required
        direction string

        Defines whether the transaction is "incoming" or "outgoing".

        Example : incoming
        Possible Values : incoming outgoing
Try it out

Request Example

POST
https://rest.cryptoapis.io/v2/blockchain-events/bitcoin/testnet/subscriptions/address-coins-transactions-confirmed-each-confirmation
Headers
Host: https://rest.cryptoapis.io/v2
Content-Type: application/json
X-API-Key: my-api-key

Request Body
{
    "context": "",
    "data": {
        "item": {
            "address": "mho4jHBcrNCncKt38trJahXakuaBnS7LK5",
            "allowDuplicates": true,
            "callbackSecretKey": "yourSecretKey",
            "callbackUrl": "http://example.com",
            "confirmationsCount": 3
        }
    }
}

Response Example

{
    "apiVersion": "2.0",
    "requestId": "601c1710034ed6d407996b30",
    "context": "You can add any text here",
    "data": {
        "item": {
            "address": "15XyNC88pujwuuur8DCsXBCfEhJJMzHayU",
            "callbackSecretKey": "yourSecretKey",
            "callbackUrl": "https://example.com",
            "confirmationsCount": 2,
            "createdTimestamp": 1611238648,
            "eventType": "ADDRESS_COINS_TRANSACTION_CONFIRMED_EACH_CONFIRMATION",
            "isActive": true,
            "referenceId": "bc243c86-0902-4386-b30d-e6b30fa1f2aa",
            "transactionId": "96b4ea92dcca3a046c0ca2738ed9400f3c04f6c5f497cce4f3a148b1c948a1b3"
        }
    }
}

Callback Example

{
    "apiVersion": "2.0",
    "referenceId": "6038d09050653d1f0e40584c",
    "idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
    "data": {
        "product": "Blockchain Events",
        "event": "ADDRESS_COINS_TRANSACTION_CONFIRMED_EACH_CONFIRMATION",
        "item": {
            "blockchain": "bitcoin",
            "network": "testnet",
            "address": "15282N4BYEwYh3j1dTgJu64Ey5qWn9Po9F",
            "minedInBlock": {
                "height": 667754,
                "hash": "dfe45f6724b550c281107ffaa5880cb280878fb4dbaa742aa21449f3d2340c13",
                "timestamp": 1610365314
            },
            "transactionId": "cbd3dea703bd2bc78bca69ee61ca14e6ffcdd809d07ebbc3b8fea3c30ea38f33",
            "currentConfirmations": 8,
            "targetConfirmations": 12,
            "amount": "0.0611",
            "unit": "BTC",
            "direction": "incoming"
        }
    }
}