Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/workflows/docs-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Docs build

on:
push:
branches: [main]
pull_request:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: "20"
cache: npm
- run: npm ci
- run: npm run build
1 change: 1 addition & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ FROM nginx:stable-alpine
WORKDIR /app

COPY --from=builder /app/build /usr/share/nginx/html
COPY nginx/default.conf /etc/nginx/conf.d/default.conf

EXPOSE 80

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import FAQ from "@site/src/components/FAQ";

# What are Internal Transactions & How to Get Them?

In blockchain a transaction is the transfer of value between two participants, recorded on a digital ledger. Not all transactions involve the direct sending of funds from one wallet to another, some transactions occur within smart contracts. These transactions are known as internal transactions.
Expand Down Expand Up @@ -246,3 +248,10 @@ transactions associated with the wallet address to ensure that all movements of
Tracking internal transactions is important to ensure the transparency and integrity of blockchain activities. By using tools such as Bitquery to monitor these transactions, users can verify the movement of their funds and also understand the flow of assets within smart contracts, thus ensuring the wallet balances are accurate. This is important for developers and users who need to maintain trust and security in decentralized applications.

For more information and related content, visit the [Bitquery blog](https://bitquery.io/blog) or explore the [documentation](https://docs.bitquery.io/).
<FAQ
items={[
{ q: "What is an internal transaction?", a: "An internal transaction is a value transfer or contract call triggered inside an outer transaction — for example a DEX swap routed through a router contract." },
{ q: "How do I fetch internal transactions with Bitquery?", a: "Use EVM.Calls or trace-style APIs filtered by transaction hash, contract address, or method signature." },
{ q: "Are internal transactions the same as token transfers?", a: "No. Transfers move tokens between addresses. Internal calls show contract execution paths — both are useful for wallet and DeFi forensics." },
]}
/>
11 changes: 10 additions & 1 deletion docs/blockchain/Arbitrum/gmx-api.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import FAQ from "@site/src/components/FAQ";

# GMX API

This section covers how to retrieve staking information on GMX.
Expand Down Expand Up @@ -195,4 +197,11 @@ The following query retrieves the latest GMX events on the Arbitrum network:
}
```

These queries help you explore the latest activities and positions on the GMX protocol.
These queries help you explore the latest activities and positions on the GMX protocol.

<FAQ
items={[
{ q: "What GMX data can I query?", a: "GMX trades and related on-chain activity on Arbitrum via EVM DEX and protocol-specific filters." },
{ q: "How do I filter GMX perpetual trades?", a: "Use the protocol filters and examples on this page for GMX on Arbitrum." },
]}
/>
8 changes: 8 additions & 0 deletions docs/blockchain/BSC/bsc-uniswap-api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 7
---
import FAQ from "@site/src/components/FAQ";

import VideoPlayer from "../../../src/components/videoplayer.js";

Expand Down Expand Up @@ -260,3 +261,10 @@ query MyQuery {
}

```

<FAQ
items={[
{ q: "How do I get Uniswap trades on BSC?", a: "Query EVM.DEXTrades with network bsc and filter Trade.Dex.ProtocolName for Uniswap versions on BNB Chain." },
{ q: "Does this include Uniswap v3 on BSC?", a: "Yes — see v3 pool and trade examples on this page." },
]}
/>
9 changes: 9 additions & 0 deletions docs/blockchain/BSC/four-meme-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ keywords:
- Four Meme PancakeSwap migration
- BSC memecoin API
---
import FAQ from "@site/src/components/FAQ";

import VideoPlayer from "../../../src/components/videoplayer.js";

Expand Down Expand Up @@ -2330,3 +2331,11 @@ These mirror common “answer engine” questions. Each item points to the secti
- [Tutorial](https://docs.bitquery.io/docs/streams/sniper-trade-using-bitquery-kafka-stream/)
- [Source Code](https://github.com/Kshitij0O7/evm-sniper)
- [Video](https://youtu.be/vgOHgqTJmj0?si=yfUguMWdMtxRJMvg)

<FAQ
items={[
{ q: "How do I get Four Meme token trades on BSC?", a: "Query EVM.DEXTrades on network bsc filtered to the Four Meme protocol. Examples cover new launches, OHLC, and top traders." },
{ q: "Can I stream Four Meme trades before they confirm?", a: "Use the Four Meme Mempool API for pre-confirmation monitoring, or Kafka streams for confirmed trades at scale." },
{ q: "How do I get OHLC for a Four Meme token?", a: "Use DEXTradeByTokens with interval aggregation on network bsc, or see the OHLC examples on this page." },
]}
/>
8 changes: 8 additions & 0 deletions docs/blockchain/BSC/four-meme-mempool-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Four Meme Mempool API - Real-Time Pre-Confirmation Monitoring"
description: "Monitor Four Meme memecoin transactions in real-time before confirmation. Track pending trades, token creations, and detect opportunities early with ultra-low latency mempool streams on BSC."
---
import FAQ from "@site/src/components/FAQ";

# Four Meme Mempool API - Real-Time Pre-Confirmation Monitoring

Expand Down Expand Up @@ -888,3 +889,10 @@ You may also be interested in:
If you have any questions or need assistance with Four Meme mempool monitoring, reach out to our [Telegram support](https://t.me/Bloxy_info).

For enterprise solutions and Kafka stream access, contact our team for a custom plan.

<FAQ
items={[
{ q: "What is the Four Meme mempool API?", a: "See Four Meme transactions in the mempool before confirmation — useful for snipers and monitoring." },
{ q: "How is mempool data different from confirmed trades?", a: "Mempool shows pending txs that may never land. Use DEXTrades for confirmed swap history." },
]}
/>
9 changes: 9 additions & 0 deletions docs/blockchain/BSC/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ keywords:
- BSC token api
- BSC transaction api
---
import FAQ from "@site/src/components/FAQ";

# BSC API Documentation

Expand Down Expand Up @@ -104,3 +105,11 @@ import VideoPlayer from "../../../src/components/videoplayer.js";
### Video Tutorial on BSC Protobuf Streams | Building BSC Sniper Trading Bot Using Bitquery Protobuf Kafka Streams

<VideoPlayer url="https://youtu.be/vgOHgqTJmj0" />

<FAQ
items={[
{ q: "What BSC data does Bitquery provide?", a: "DEX trades, token transfers, Four Meme, PancakeSwap, mempool streams, blocks, and smart contract calls." },
{ q: "How do I query BSC DEX trades?", a: "Use EVM.DEXTrades with network bsc and filter by protocol or token contract address." },
{ q: "Can I get real-time BSC streams?", a: "Yes via GraphQL subscriptions, Kafka, or mempool APIs depending on your use case." },
]}
/>
10 changes: 10 additions & 0 deletions docs/blockchain/BSC/pancake-swap-api.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import FAQ from "@site/src/components/FAQ";

import VideoPlayer from "../../../src/components/videoplayer.js";

# Pancake Swap API
Expand Down Expand Up @@ -1118,3 +1120,11 @@ query pairDexList(
### How to get PancakeSwap trades in realtime

<VideoPlayer url="https://www.youtube.com/watch?v=T_BWvxYd4Pc" />

<FAQ
items={[
{ q: "How do I query PancakeSwap trades on BSC?", a: "Use EVM.DEXTrades with network bsc and filter Trade.Dex.ProtocolName for PancakeSwap v2 or v3." },
{ q: "Does Bitquery cover PancakeSwap v3 pools?", a: "Yes. This page includes v2 and v3 trade and pool examples — pick the version that matches your pair." },
{ q: "Can I stream PancakeSwap trades live?", a: "Use GraphQL subscriptions on EVM.DEXTrades or Kafka EVM protobuf streams for production pipelines." },
]}
/>
8 changes: 8 additions & 0 deletions docs/blockchain/Base/aerodrome-base-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "Aerodrome Finance API - Base DEX Trades, Liquidity Pools, Token Analytic
description: "Get real-time Aerodrome Finance DEX trades, liquidity pools, token prices, trading volume and analytics on Base network. Access comprehensive on-chain data via Aerodrome API, Streams and GraphQL."
sidebar_position: 7
---
import FAQ from "@site/src/components/FAQ";

# Aerodrome Finance API - Base DEX Trades, Liquidity Pools, Token Analytics

Expand Down Expand Up @@ -422,3 +423,10 @@ query MyQuery {
### Video Tutorial | How to Get Latest Liquidity Pools and Pool Liquidity on Aerodrome Finance

<VideoPlayer url="https://youtu.be/HvuD4Gtaonc" />

<FAQ
items={[
{ q: "How do I get Aerodrome trades on Base?", a: "Query EVM.DEXTrades on network base with Aerodrome protocol filters from the examples on this page." },
{ q: "Can I track new Aerodrome pools?", a: "Yes. Query DEXPools filtered to Aerodrome and sort by creation time or subscribe to new pool events." },
]}
/>
9 changes: 9 additions & 0 deletions docs/blockchain/Base/base-dextrades.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 2
---
import FAQ from "@site/src/components/FAQ";

# Base Chain DEX Trades API

Expand Down Expand Up @@ -636,3 +637,11 @@ You can run this query [in the Bitquery IDE](https://ide.bitquery.io/Top-Traders
## Video Tutorial | How to get Base Decentralized Exchange Data with DEX Trades API

<VideoPlayer url="https://www.youtube.com/watch?v=RJJAo0yDf18" />

<FAQ
items={[
{ q: "How do I query DEX trades on Base?", a: "Use EVM.DEXTrades with network base. Filter by protocol (Aerodrome, Uniswap, etc.) or token pair." },
{ q: "Which Base DEXs are covered?", a: "Aerodrome, Uniswap, PancakeSwap, Zora, and others listed in the Base docs." },
{ q: "Can I stream Base DEX trades?", a: "Use GraphQL subscriptions or Kafka EVM streams for live trade feeds." },
]}
/>
8 changes: 8 additions & 0 deletions docs/blockchain/Base/base-uniswap-api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 7
---
import FAQ from "@site/src/components/FAQ";

import VideoPlayer from "../../../src/components/videoplayer.js";

Expand Down Expand Up @@ -314,3 +315,10 @@ query MyQuery {
## Building with Bitquery and Uniswap API

Check [this](../../usecases/base-sniper-bot.mdx) guide to get started with building projects with real world value using Bitquery Uniswap APIs.

<FAQ
items={[
{ q: "How do I query Uniswap on Base?", a: "Use EVM.DEXTrades with network base and Uniswap protocol filters from the examples on this page." },
{ q: "Can I get OHLC for Uniswap pairs on Base?", a: "Use DEXTradeByTokens interval aggregation or Trading.Trades for recent USD candles." },
]}
/>
9 changes: 9 additions & 0 deletions docs/blockchain/Base/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ keywords:
- Uniswap v3 Base API
- Zora API
---
import FAQ from "@site/src/components/FAQ";

# Base API Documentation

Expand Down Expand Up @@ -142,3 +143,11 @@ Browse live Base memecoin DEX prices on [DEXrabbit's Base Meme Coins category](h
### Video Tutorial | Build AI Trading Agent on Base

<VideoPlayer url="https://youtu.be/ZIKi8jCrhvA" />

<FAQ
items={[
{ q: "What Base chain APIs are available?", a: "DEX trades, transfers, NFTs, Aerodrome, Uniswap, Zora, Clanker, and other Base-native protocols." },
{ q: "How do I get Aerodrome or Base DEX trades?", a: "Query EVM.DEXTrades with network base and filter by protocol name — see the Aerodrome and base-dextrades docs." },
{ q: "Is Base data near real-time?", a: "Yes. Trades and blocks are indexed as Base produces them. Use subscriptions for live apps." },
]}
/>
8 changes: 8 additions & 0 deletions docs/blockchain/Ethereum/balances/balance-api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 2
---
import FAQ from "@site/src/components/FAQ";

# Address Balance API

Expand Down Expand Up @@ -189,3 +190,10 @@ query {
}
}
```

<FAQ
items={[
{ q: "How do I check an Ethereum wallet balance?", a: "Query EVM balance APIs with the wallet address. Add a token contract filter for ERC-20 balances." },
{ q: "Can I track balance changes over time?", a: "Use balance update APIs or historical queries documented on this page." },
]}
/>
30 changes: 9 additions & 21 deletions docs/blockchain/Ethereum/calls/smartcontract.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 2
---
import FAQ from "@site/src/components/FAQ";

# SmartContract Calls API

Expand All @@ -23,28 +24,15 @@ sidebar_position: 2
<meta property="twitter:description" content="Retrieve detailed information about smart contract transactions, function calls, input/output parameters, and contract interactions on Ethereum using our comprehensive API." />
</head>

## Frequently Asked Questions (FAQ)

### What is the Smart Contract Calls API?

The Smart Contract Calls API helps you retrieve comprehensive information about smart contract transactions on Ethereum, including details about the contract function that was called, input and output parameters, gas usage, and more. This data enables you to build applications that interact with smart contracts, perform analytics on contract activity, and monitor contract interactions in real-time.

### What data can I get from the Smart Contract Calls API?

The API provides data for:
- **Function Calls**: Details about which contract functions were called and their parameters
- **Transaction Information**: Gas usage, transaction hash, sender/receiver addresses, and transaction status
- **Contract Creation**: Track new contract deployments with creation details
- **Internal Calls**: Monitor internal function calls within smart contracts


### How do I use Bitquery's Ethereum APIs?

Bitquery provides GraphQL APIs for Ethereum data. You can test queries using the IDE at ide.bitquery.io or convert queries to subscriptions for real-time data via WebSocket connections. To access API outside the IDE, you need to use your OAuth token, generate one [here](https://account.bitquery.io/user/api_v2/access_tokens). For enterprise users, we also offer Kafka streams for high-throughput data processing.

### What Kafka streams are available for Ethereum?

Bitquery provides managed Kafka topics including `ethereum.tokens.proto`, `ethereum.transactions.proto`, and `ethereum.dextrades.proto` with pre-parsed, enriched Protocol-Buffers events. These streams offer sub-second latency and enterprise-grade reliability for high-volume data processing. Read more [here](https://docs.bitquery.io/docs/streams/kafka-streaming-concepts/).
<FAQ
items={[
{ q: "What is the Smart Contract Calls API?", a: "Query which functions were called on Ethereum contracts, with decoded inputs, gas usage, internal calls, and transaction context." },
{ q: "When should I use Calls vs Events vs Transfers?", a: "Use Calls for function execution traces. Use Events for emitted logs. Use Transfers for token movements. See the Mental Model guide linked on this page." },
{ q: "Can I track new contract deployments?", a: "Yes. Filter EVM.Calls with Call.Create true to list recent contract creation calls." },
{ q: "Can I stream contract calls in real time?", a: "Yes. Convert your query to a GraphQL subscription or use Kafka ethereum.transactions.proto for high-volume monitoring." },
]}
/>

## Smart Contract Calls API Guide

Expand Down
9 changes: 9 additions & 0 deletions docs/blockchain/Ethereum/dextrades/dex-api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_label: DEX Trades API
---
import FAQ from "@site/src/components/FAQ";

# DEX API

Expand Down Expand Up @@ -245,3 +246,11 @@ query LatestTrades($network: evm_network, $market: String) {
![image](https://github.com/user-attachments/assets/4495ec8e-ab55-4cf9-8b58-99ef264dcc1d)

You can check the data here on [DEXrabbit](https://dexrabbit.com/eth/dex_market/Uniswap#trades).

<FAQ
items={[
{ q: "How do I get Uniswap or DEX trades on Ethereum?", a: "Query EVM.DEXTrades on network eth and filter by Trade.Dex.ProtocolName such as uniswap_v3 or uniswap_v2." },
{ q: "How do I build OHLC from Ethereum DEX trades?", a: "Use DEXTradeByTokens with interval parameters, or the Crypto Price / OHLC API for recent USD candles." },
{ q: "Which DEXs are indexed on Ethereum?", a: "Uniswap v2/v3/v4, Curve, Balancer, 1inch, and many others — filter by protocol name in your query." },
]}
/>
12 changes: 7 additions & 5 deletions docs/blockchain/Ethereum/dextrades/ethereum-slippage-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 3
sidebar_label: Slippage & Price Impact
---
import FAQ from "@site/src/components/FAQ";

# EVM DEX Slippage API

Expand Down Expand Up @@ -317,8 +318,9 @@ For a practical implementation example of using slippage data for automated trad

For more advanced use cases, refer to the [DEXPools Cube documentation](https://docs.bitquery.io/docs/cubes/evm-dexpool/#advanced-use-cases-and-processing-patterns).

## Frequently Asked Questions

### How does slippage affect DEX trading?

Slippage affects DEX trading by causing the actual execution price to differ from the expected price. When you swap tokens in a DEX pool, larger trades move the price along the liquidity curve—the more you buy or sell, the worse the price you get. This means you receive fewer output tokens than you expected (or pay more input tokens). Slippage is higher in shallow pools and for large orders. Use the DEXPoolSlippages API to check `MaxAmountIn` and `MinAmountOut` at different slippage tolerances before trading, so you can choose pools with enough liquidity and set appropriate slippage limits.
<FAQ
items={[
{ q: "How do I calculate slippage on a DEX trade?", a: "Compare the executed trade price to the pool mid-price at block time using trade and pool reserve fields." },
{ q: "Do I need pool reserves to measure slippage?", a: "Yes — combine DEXTrades execution data with DEXPools liquidity snapshots from the same block or interval." },
]}
/>
8 changes: 8 additions & 0 deletions docs/blockchain/Ethereum/dextrades/evm-gmgn-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ keywords:
- Uniswap v3 new pools stream
- Bitquery GraphQL DEX API
---
import FAQ from "@site/src/components/FAQ";

# GMGN API for Ethereum & EVM chains

Expand Down Expand Up @@ -581,3 +582,10 @@ query MyQuery {
}
}
```

<FAQ
items={[
{ q: "What is the GMGN-style API on Bitquery?", a: "Rank tokens and pairs by volume, trades, and price change using DEX trade aggregations — similar to GMGN dashboards." },
{ q: "Which chains are supported?", a: "Ethereum and other EVM chains — see examples for the networks you need." },
]}
/>
10 changes: 9 additions & 1 deletion docs/blockchain/Ethereum/dextrades/uniswap-api.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_label: Uniswap v1–v3 Trades
---
import FAQ from "@site/src/components/FAQ";

# Uniswap API

Expand Down Expand Up @@ -678,4 +679,11 @@ You can get Uniswap data with sub-second latency via Kafka Streams. Read more [h
Contact us on our telegram channel for a trial credentials.

<VideoPlayer url="https://youtu.be/xcW_Na7YwSk" />
```

<FAQ
items={[
{ q: "How do I query Uniswap trades on Ethereum?", a: "Filter EVM.DEXTrades with network eth and Trade.Dex.ProtocolName for uniswap_v2, uniswap_v3, or uniswap_v4." },
{ q: "Can I get pool-level OHLC for Uniswap pairs?", a: "Yes. Use DEXTradeByTokens with interval aggregation on the pair or token mint." },
{ q: "Does Bitquery support Uniswap v4?", a: "Yes where indexed — see the Uniswap v4 API doc for v4-specific pool and hook fields." },
]}
/>
Loading
Loading