ArweaveKit Docs
  • ArweaveKit
    • Introduction
  • 🔐Wallets
    • Introduction to Wallets
    • Create Wallet
    • Get Wallet Address
    • Get Wallet Balance
    • Wallet Plugins
  • 💳ARWEAVE WALLET KIT
    • Introduction to Arweave Wallet Kit
    • Setup
    • Connect Button
    • Hooks
    • Customization
  • 🏦Transactions
    • Introduction to Transactions
    • Create Transaction
    • Sign Transaction
    • Post Transaction
    • Get Transaction Status
    • Get Transaction
    • Create and Post Transaction with Othent
    • Transaction Plugins
  • 📄SMART CONTRACTS
    • Introduction to Smart Contracts
    • Create Contract
    • Write Contract
    • Read Contract State
    • View Contract State
    • Write Contract with Othent
    • Read Contract with Othent
    • Smart Contract Plugins
  • ✅AUTH
    • Introduction to Auth
    • Connect
    • Disconnect
    • Get Active Address
    • Get Permissions
    • Get Wallet Names
    • Get All Addresses
    • Get Active Public Key
    • Is Installed
    • Log In with Othent
    • Log Out with Othent
    • Get User Details with Othent
    • Auth Plugins
  • 🔐Encryption
    • Introduction to Encryption
    • Encrypt Data with AES
    • Decrypt Data with AES
    • Encrypt AES Key with RSA
    • Decrypt AES Key with RSA
    • Encryption Plugins
  • 🌐GRAPHQL
    • Introduction to GraphQL
    • Query All Arweave Transactions
    • Query Arweave Data
    • Query Arweave Transactions
    • GraphQL Plugins
  • 🗺️RoadMap
    • Features
  • 📘REFERENCES
    • ArweaveKit in Browser Environments
  • 🛠️SUPPORTING TOOLS
    • Arweave StarterKit
Powered by GitBook
On this page
  • Basic Syntax
  • Input Parameters
  • Returned Data

Was this helpful?

  1. GRAPHQL

Query Arweave Data

Query GraphQL for Arweave Blocks and Transactions data

You can query for everything that Arweave GraphQL endpoint supports. For instance, single transaction, more than one transaction, single block, more than one block.

Basic Syntax

The function that we will be using is queryGQL. For implementation details, see below.

import { queryGQL } from 'arweavekit/graphql';

const response = await queryGQL(queryString, options);

Input Parameters

You must supply queryGQL with two inputs.

  • QueryString: string - A valid GraphQL query string.

  • Options: object - An options object.

    • gateway: string - Gateway url like arweave.net

    • filters: object - Filters object like first: 100 . In case of no filters, pass an empty object.

Returned Data

The expected response will be an object with following fields.

  • status: number - Query HTTP status code. Example, 200.

  • data: object | null - Successful response will return GraphQL node or list of GraphQL edges and in case of failure null will be returned here.

  • errors: GraphQLError[] | null - Incase of failure you can expect this field to be non-nullish and a list of GraphQLError is provided.

    • GraphQLError: object - GraphQL error object contains following fields:

      • message: string - Error message in string format

      • extensions: object - This object has a field code and its supposed to provide you with error code.

PreviousQuery All Arweave TransactionsNextQuery Arweave Transactions

Last updated 1 year ago

Was this helpful?

🌐