メインコンテンツまでスキップ

トランザクション

トランザクションカテゴリーは、Finschiaのトランザクションに関するAPI endpointが含まれます。以下のendpointを利用してトランザクションを確認してください。

トランザクションを取得する

 TestnetMainnet

指定されたトランザクションの状態および情報を取得します。

GET /v2/transactions/{txHash}

回答に含まれるmessages[].detailsはv2.12.0（5月末）からサポートを停止しましたので、トランザクションに含まれるメッセージの詳細を見るにはトランザクションメッセージを取得するエンドポイントを呼び出してください。

Path

Name
TypeDescription
txHash Requiredstring

取得するtransactionのhash

Query

なし

Body

なし

ヘッダー
  • service-api-key
  • Signature
  • Timestamp
  • Nonce

詳しくは、リクエストヘッダーを参照してください。

リクエストの例
import os

import requests
import random
import string
import time

def GET_v2_transactions_txHash():
    server_url = os.environ['SERVER_URL']
    service_api_key = os.environ['SERVICE_API_KEY']
    service_api_secret = os.environ['SERVICE_API_SECRET']

    nonce = ''.join(random.choice(string.ascii_uppercase + string.ascii_lowercase + string.digits) for _ in range(8))
    timestamp = int(round(time.time() * 1000))


    path = '/v2/transactions/61AB8A054D47CA05E4ABE591B929282CBCD7DACD5A4C8259020C566F0EC186BE'

    headers = {
        'service-api-key': service_api_key,
        'nonce': nonce,
        'timestamp': str(timestamp)
    }


    signature = get_signature('GET', path, nonce, timestamp, service_api_secret)
    headers['signature'] = signature

    res = requests.get(server_url + path, headers=headers)
    return res.json()

トランザクションメッセージを取得する

 TestnetMainnet

トランザクションに含まれたメッセージを取得します。

GET /v2/transactions/{txHash}/messages

ページ単位で取得する(pagination)

LINE Blockchain Developer APIは、ページをスクロールする方式でページ単位で取得するを設計しました。並べ替えたメッセージ一覧で、昇順または降順のいずれかの方向にページをスクロールしながらそのページにあるメッセージを読み取る方式です。

この方式では、読む方向を維持したまま次のページを順番に閲覧することを推奨します。 途中で前のページに戻ると、読む方向が変わります。例えば、降順のページを読んでいる途中で前のページに戻ると、読む方向は昇順になります。1ページにメッセージが2つ以上の場合、ページ内のメッセージの順番も読む方向に従います。以下の例を参照してください。

1、2、3、4、5、6、7の7つのメッセージがあると想定します。ページのサイズ（1ページに含まれる最大のメッセージ数）を2に設定してページを降順で読むと、最初のページの値は以下のとおりになります。

  • 並び順：降順
  • 並べ替えられたメッセージ：7、6、5、4、3、2、1
  • ページに含まれるメッセージ：7、6

スクロール方向とページのサイズを維持する場合、次のページは以下の値になります。

  • 並び順：降順
  • 並べ替えられたメッセージ：7、6、5、4、3、2、1
  • ページに含まれるメッセージ：5、4

これで2ページまで読みました。ここで前のページに戻ると、スクロール方向が変わってしまい、メッセージも逆順に表示されます。

  • 並び順：昇順（*逆方向）
  • 並べ替えられたメッセージ：1、2、3、4、5、6、7
  • ページに含まれるメッセージ：6、7 (*逆順)

pagination

Path

Name
TypeDescription
txHash Requiredstring

取得するtransactionのhash

Query

Name
TypeDescription
limit integer

1ページに含まれる最大のメッセージ数。ページ単位で取得するにおいてページのサイズを意味します。

  • Default: 50
  • Max: 100
orderBy †string

メッセージの並び順。並べ替えの基準はmsgIndexで、この属性で順序を指定できます。以下のいずれかを入力してください。

  • "desc"：降順
  • "asc"：昇順 (default)

最初のページを取得するときのみ有効です。pageTokenと一緒に使うとエラーを返します。

pageToken †string

取得するページの最初の要素を指すpage token。 以前の応答のprePageTokenまたはnextPageTokenを入力して取得するページを変更できます。 この値を""やnullに設定するか、または空欄にすると、最初のページを取得します。

  • Default: ""

† orderBy、pageTokenのいずれか1つのみ入力します。

Body

なし

ヘッダー
  • service-api-key
  • Signature
  • Timestamp
  • Nonce

詳しくは、リクエストヘッダーを参照してください。

リクエストの例
import os

import requests
import random
import string
import time

def GET_v2_transactions_txHash():
    server_url = os.environ['SERVER_URL']
    service_api_key = os.environ['SERVICE_API_KEY']
    service_api_secret = os.environ['SERVICE_API_SECRET']

    nonce = ''.join(random.choice(string.ascii_uppercase + string.ascii_lowercase + string.digits) for _ in range(8))
    timestamp = int(round(time.time() * 1000))


    path = '/v2/transactions/0728E4DD025EEA027E55181CBE394F8D3AEB098668630A9CB6A9EEDA46F35057/messages'

    query_params = {
        'limit': 10,
        'orderBy': 'asc',
        'pageToken': ''
    }

    headers = {
        'service-api-key': service_api_key,
        'nonce': nonce,
        'timestamp': str(timestamp)
    }


    signature = get_signature('GET', path, nonce, timestamp, service_api_secret, query_params)
    headers['signature'] = signature

    res = requests.get(server_url + path, params=query_params, headers=headers)
    return res.json()
に最終更新