Flipside Crypto

https://docs.flipsidecrypto.com
Admin
Flipside Crypto is a blockchain data and AI platform providing programmatic access to data across...
Tokens:420,647
Snippets:4,030
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Flipside CLI via Script

Source: https://docs.flipsidecrypto.com/flipspace/cli/installation

Run the installation script to download the binary and add it to your PATH.

```bash
curl -fsSL https://raw.githubusercontent.com/FlipsideCrypto/flipside-tools/main/install.sh | sh
```

--------------------------------

### Verify CLI Installation

Source: https://docs.flipsidecrypto.com/flipspace/cli/installation

Check the installed version of the CLI to confirm successful setup.

```bash
flipside --version
```

--------------------------------

### Example Workflow: Create, Execute, and Download

Source: https://docs.flipsidecrypto.com/flipspace/cli/queries

This example demonstrates a common workflow: creating a query, executing it, waiting for completion, and downloading the results. It utilizes shell variables and `jq` for parsing JSON output.

```bash
# Create and execute in one flow
QUERY_ID=$(flipside query create "SELECT * FROM ethereum.core.fact_transactions LIMIT 100" --json | jq -r '.id')

RUN_ID=$(flipside query execute $QUERY_ID --json | jq -r '.id')

# Wait for completion and download
flipside query-run poll $RUN_ID --timeout 10m
flipside query-run download $RUN_ID --output results.csv
```

--------------------------------

### SQL Usage Examples

Source: https://docs.flipsidecrypto.com/blockchain-data/ink/defi/ez-dex-swaps

Examples of SQL queries for analyzing DEX swap data and monitoring data freshness.

```APIDOC
## SQL Usage Examples

### Description
This section provides practical SQL query examples for interacting with DEX swap data, including tracing event execution and monitoring data latency and modifications.

### Query Examples

#### Trace Event Execution Flow
```sql
-- Trace event execution flow
SELECT
    event_index,
    contract_address,
    topic_0,
    SUBSTRING(data, 1, 10) AS data_preview
FROM <blockchain_name>.core.fact_event_logs
WHERE tx_hash = '0xabc...'
ORDER BY event_index;
```

#### Data Freshness Monitoring
```sql
-- Check data latency
SELECT
    DATE_TRUNC('hour', block_timestamp) as block_hour,
    DATE_TRUNC('hour', inserted_timestamp) as insert_hour,
    AVG(TIMESTAMPDIFF('minute', block_timestamp, inserted_timestamp)) as avg_latency_minutes
FROM <blockchain_name>.core.fact_transactions
WHERE block_timestamp >= CURRENT_DATE - 1
GROUP BY 1, 2;
```

#### Recently Modified Records
```sql
-- Recently modified records
SELECT *
FROM <blockchain_name>.core.fact_transactions
WHERE modified_timestamp > inserted_timestamp
AND modified_timestamp >= CURRENT_DATE - 1;
```

#### Data Quality Tracking
```sql
-- Data quality tracking
SELECT
    DATE(modified_timestamp) as mod_date,
    COUNT(*) as records_updated,
    COUNT(DISTINCT block_number) as blocks_affected
FROM <blockchain_name>.core.fact_transactions
WHERE modified_timestamp > inserted_timestamp
GROUP BY 1
ORDER BY 1 DESC;
```
```

--------------------------------

### Start Interactive Chat with Flipside CLI

Source: https://docs.flipsidecrypto.com/flipspace/cli

Initiates a conversational session with AI agents for natural language querying. No setup required beyond CLI installation.

```bash
flipside chat
```

--------------------------------

### Advanced Prompt with Examples

Source: https://docs.flipsidecrypto.com/flipsideai/prompting

Providing descriptive examples helps the AI understand the specific criteria for the requested analysis.

```text
Find protocols similar to Uniswap (automated market makers with liquidity pools)
that launched on Arbitrum in 2023.
```

--------------------------------

### API Reference Documentation

Source: https://docs.flipsidecrypto.com/updates

Access to the full API Reference documentation, including a Getting Started guide and interactive examples.

```APIDOC
## API Reference

### Description
Full API Reference documentation is available, powered by an OpenAPI spec. It includes a Getting Started guide, a complete endpoint reference for all public API v3 endpoints, and interactive examples.

### Getting Started
- Authentication setup
- API key creation
- Usage basics

### Endpoint Reference
- Auto-generated documentation for all public API v3 endpoints.

### Interactive Examples
- Try out API calls directly from the docs.
```

--------------------------------

### Context-Specific Prompt Example

Source: https://docs.flipsidecrypto.com/flipsideai/prompting

An example of a prompt that specifies the subject matter clearly.

```text
Show me USDC transfers.
```

--------------------------------

### Basic Prompt Example

Source: https://docs.flipsidecrypto.com/flipsideai/prompting

An example of a vague prompt that lacks specific context.

```text
Tell me about swaps on Blur.
```

--------------------------------

### Troubleshoot PATH and Permissions

Source: https://docs.flipsidecrypto.com/flipspace/cli/installation

Commands for fixing PATH issues or handling installation permissions.

```bash
export PATH="/usr/local/bin:$PATH"
```

```bash
curl -fsSL https://raw.githubusercontent.com/FlipsideCrypto/flipside-tools/main/install.sh | sudo sh
```

```bash
mkdir -p ~/.local/bin
curl -fsSL https://raw.githubusercontent.com/FlipsideCrypto/flipside-tools/main/install.sh | sh -s -- --install-dir ~/.local/bin
```

```bash
flipside logout
flipside login
```

--------------------------------

### Interactive Session Example

Source: https://docs.flipsidecrypto.com/flipspace/cli/chat

A demonstration of natural language interaction within the REPL.

```text
> What were the top 10 NFT collections by volume yesterday?

I'll query the NFT sales data for you...

[Results displayed]

> Can you break that down by marketplace?

Sure, let me add marketplace grouping...

[Updated results]
```

--------------------------------

### Starting Chat Sessions

Source: https://docs.flipsidecrypto.com/flipspace/cli/chat

Commands to initiate, resume, or contextually link a chat session.

```bash
# Start a new interactive session
flipside chat

# Chat about a specific automation run
flipside chat --run <run-id>

# Resume an existing chat session
flipside chat resume
```

--------------------------------

### Metadata update example

Source: https://docs.flipsidecrypto.com/api-reference/chat/update-chat-session

Example of the meta object structure for the request body.

```json
{ "title": "My Chat" }
```

--------------------------------

### Data and Query Prompts

Source: https://docs.flipsidecrypto.com/flipspace/chat

Examples of natural language prompts for querying blockchain data and inspecting table schemas.

```text
"What's the daily DEX volume on Arbitrum over the past 30 days?"
"Show me the schema for the Hyperliquid trades table"
"Find the top 5 wallets by realized PnL on Hyperliquid"
```

--------------------------------

### Querying dim_stablecoins

Source: https://docs.flipsidecrypto.com/blockchain-data/crosschain/defi/dim-stablecoins

Examples of how to query the dim_stablecoins table to retrieve stablecoin information.

```APIDOC
## SQL Queries for dim_stablecoins

### Description
These queries demonstrate how to interact with the `dim_stablecoins` table to identify stablecoins, filter by symbol, or verify specific contract addresses.

### Table
`crosschain.defi.dim_stablecoins`

### Columns
- **BLOCKCHAIN** (TEXT) - Blockchain, Network, or Platform the token price is recorded on.
- **CONTRACT_ADDRESS** (TEXT) - The unique smart contract address of the stablecoin token.
- **SYMBOL** (TEXT) - The symbol identifier for the stablecoin token.
- **NAME** (TEXT) - The full name of the stablecoin token.
- **LABEL** (TEXT) - A combined display label containing both symbol and name.
- **DECIMALS** (NUMBER) - The number of decimal places used by the token contract.
- **IS_VERIFIED** (BOOLEAN) - Indicates whether the stablecoin is verified by the Flipside team.
- **DIM_STABLECOINS_ID** (TEXT) - The unique identifier for each row in the table.

### Query Examples

#### Get unique stablecoins
```sql
SELECT 
    label AS stablecoin,
    COUNT(*) AS token_count
FROM <blockchain_name>.defi.dim_stablecoins
GROUP BY 1
ORDER BY 2 DESC;
```

#### Get all USDC variants
```sql
SELECT 
    contract_address,
    symbol,
    name,
    decimals
FROM <blockchain_name>.defi.dim_stablecoins
WHERE symbol LIKE '%USDC%'
ORDER BY symbol;
```

#### Check if specific address is a stablecoin
```sql
SELECT 
    contract_address,
    label,
    decimals
FROM <blockchain_name>.defi.dim_stablecoins
WHERE contract_address = LOWER('0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48');
```
```

--------------------------------

### Report and Visualization Prompts

Source: https://docs.flipsidecrypto.com/flipspace/chat

Examples of natural language prompts for generating charts and dashboards from query results.

```text
"Create a line chart showing Aave TVL over the past quarter"
"Build a comparison dashboard for DEX volumes across L2s"
```

--------------------------------

### Quick Start: Create and Run Query

Source: https://docs.flipsidecrypto.com/flipspace/cli/queries

This command creates and immediately executes a SQL query against the data warehouse.

```bash
# Create and run a query
flipside query create "SELECT block_number, block_timestamp FROM ethereum.core.fact_blocks LIMIT 10"
```

--------------------------------

### Configure Binary Permissions and Path

Source: https://docs.flipsidecrypto.com/flipspace/cli/installation

Make the downloaded binary executable and move it to a system-wide directory.

```bash
chmod +x flipside-*
mv flipside-* /usr/local/bin/flipside
```

--------------------------------

### Get Workflow Tool

Source: https://docs.flipsidecrypto.com/flipspace/mcp/automations

Retrieve detailed information about a specific workflow using its ID with the `get_workflow` tool. This provides insights into the workflow's name, description, required inputs, methodology, and example outputs.

```tool
Tool: get_workflow
Parameters:
  - id: Workflow ID

Returns:
  * Workflow name and description
  * Required inputs
  * Step-by-step methodology
  * Example outputs
```

--------------------------------

### Initialize a New Skill

Source: https://docs.flipsidecrypto.com/flipspace/cli/skills

Use this command to create a new skill configuration file. This sets up the basic structure for your skill, including its name, description, available tools, and context.

```bash
flipside skills init my_skill
```

--------------------------------

### Skill Configuration File Example

Source: https://docs.flipsidecrypto.com/flipspace/agents/skills

A sample YAML configuration file for a custom skill, defining its name, description, enabled tools, and context.

```yaml
name: my_skill
description: |
  Domain expertise for analyzing DeFi protocols...
tools:
  - find_tables
  - get_table_schema
  - run_sql_query
context: |
  Key tables for DeFi analysis:
  - ethereum.defi.ez_dex_swaps
  - ethereum.defi.ez_lending_deposits
  ...
```

--------------------------------

### Initialize and Deploy a Custom Skill with Flipside CLI

Source: https://docs.flipsidecrypto.com/flipspace/agents/skills

Use the Flipside CLI to initialize a new skill and then deploy it. Ensure the skill configuration file is correctly formatted.

```bash
# Initialize a new skill
flipside skills init my_skill

# Deploy the skill
flipside skills push my_skill.yaml
```

--------------------------------

### Initialize and Deploy a New Agent with Flipside CLI

Source: https://docs.flipsidecrypto.com/flipspace/agents/agents

Use the Flipside CLI to initialize a new agent and deploy it. Ensure you have the CLI installed and configured.

```bash
# Initialize a new agent
flipside agents init my_agent

# Deploy the agent
flipside agents push my_agent.yaml

```

--------------------------------

### GET /queries/{id}/latest/result

Source: https://docs.flipsidecrypto.com/api-reference/queries/get-latest-query-run-result-metadata

Retrieves the metadata for the latest query run result. This endpoint allows you to get information about the status, timing, and location of the results for a specific query.

```APIDOC
## GET /queries/{id}/latest/result

### Description
Retrieves the metadata for the latest query run result. This endpoint allows you to get information about the status, timing, and location of the results for a specific query.

### Method
GET

### Endpoint
https://api.flipsidecrypto.xyz/public/v3/queries/{id}/latest/result

### Parameters
#### Path Parameters
- **id** (string<uuid>) - Required - The unique identifier of the query.

#### Headers
- **x-api-key** (string) - Required - Your API key for authentication.

### Response
#### Success Response (200)
- **queryRunId** (string<uuid>) - The unique identifier of the query run.
- **queryId** (string<uuid>) - The unique identifier of the query.
- **status** (enum<string>) - The status of the query run. Available options: `PENDING`, `SUBMITTED`, `RUNNING`, `STREAMING`, `COMPLETED`, `FAILED`, `CANCELLED`.
- **resultLocation** (string | null) - The location where the query results are stored.
- **rowCount** (integer | null) - The number of rows in the query result.
- **executionTimeMs** (integer | null) - The execution time of the query in milliseconds.
- **columnSchema** (null[] | null) - The schema of the columns in the query result.
- **userAgent** (enum<string> | null) - The user agent that initiated the query. Available options: `web`, `cli`, `internal-cli`, `api`, `slack`, `discord`, `telegram`, `schedule`, `unknown`, `null`.
- **createdAt** (string<date-time>) - The timestamp when the query was created.
- **completedAt** (string<date-time> | null) - The timestamp when the query was completed.

### Request Example
```bash
curl --request GET \
  --url https://api.flipsidecrypto.xyz/public/v3/queries/{id}/latest/result \
  --header 'x-api-key: <api-key>'
```

### Response Example
```json
{
  "queryRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "queryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "PENDING",
  "resultLocation": "<string>",
  "rowCount": 123,
  "executionTimeMs": 123,
  "columnSchema": [
    null
  ],
  "userAgent": "web",
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}
```
```

--------------------------------

### Basic SQL Query Example

Source: https://docs.flipsidecrypto.com/flipspace/sql-editor

A standard SQL query to retrieve daily swap counts and volume from the Ethereum DEX swaps table over the last seven days.

```sql
SELECT
  DATE_TRUNC('day', block_timestamp) AS date,
  COUNT(*) AS swap_count,
  SUM(amount_in_usd) AS volume_usd
FROM ethereum.defi.ez_dex_swaps
WHERE block_timestamp >= DATEADD(day, -7, CURRENT_DATE)
GROUP BY 1
ORDER BY 1
```

--------------------------------

### Get Automation by ID using cURL

Source: https://docs.flipsidecrypto.com/api-reference/automations/get-automation-by-id

Use this cURL command to make a GET request to retrieve a specific automation's details. Replace `{id}` with the actual automation ID and `<api-key>` with your Flipside Crypto API key.

```bash
curl --request GET \
  --url https://api.flipsidecrypto.xyz/public/v3/automations/{id} \
  --header 'x-api-key: <api-key>'
```

--------------------------------

### Deploy Automation

Source: https://docs.flipsidecrypto.com/flipspace/cli/automations

Push your automation configuration to deploy it. Ensure the file path is correct.

```bash
flipside automations push my_automation.yaml
```

--------------------------------

### Get Workflow Run by ID using cURL

Source: https://docs.flipsidecrypto.com/api-reference/automation-runs/get-workflow-run-by-id

Use this cURL command to make a GET request to retrieve a specific automation workflow run. Replace `{id}` with the actual run ID and `<api-key>` with your Flipside Crypto API key.

```bash
curl --request GET \
  --url https://api.flipsidecrypto.xyz/public/v3/automation-runs/{id} \
  --header 'x-api-key: <api-key>'
```

--------------------------------

### GET /public/v3/tools

Source: https://docs.flipsidecrypto.com/api-reference/tools/list-available-tools

Retrieves a list of all available tools.

```APIDOC
## GET /public/v3/tools

### Description
List all available tools provided by the Flipside Crypto API.

### Method
GET

### Endpoint
https://api.flipsidecrypto.xyz/public/v3/tools

### Parameters
#### Header Parameters
- **x-api-key** (string) - Required - API authentication key.

#### Query Parameters
- **includeInternal** (string) - Optional - Deprecated - ignored.

### Request Example
curl --request GET \
  --url https://api.flipsidecrypto.xyz/public/v3/tools \
  --header 'x-api-key: <api-key>'

### Response
#### Success Response (200)
- **tools** (object[]) - List of available tools.

#### Response Example
{
  "tools": [
    {
      "name": "<string>",
      "description": "<string>",
      "inputSchema": "<unknown>",
      "outputSchema": "<unknown>"
    }
  ]
}
```

--------------------------------

### Manage Configuration

Source: https://docs.flipsidecrypto.com/flipspace/cli/installation

View or modify CLI settings, including environment selection.

```bash
flipside config
```

```bash
flipside -e prod query list    # Production (default)
flipside -e staging query list # Staging
```

```bash
flipside config set env prod
```

--------------------------------

### Email Node Configuration Example

Source: https://docs.flipsidecrypto.com/flipspace/automations/create-automation

Configure the email subject and body, referencing the agent's output using `{{ agent_output }}`. Ensure recipient email addresses are correct and check spam folders if delivery issues occur.

```text
Subject : “Daily Wallet Summary for ” - **Body** : Reference the agent’s output using `{{ agent_output }}`
```

--------------------------------

### Get Query Run Result Data (cURL)

Source: https://docs.flipsidecrypto.com/api-reference/query-runs/get-query-run-result-data

Use this cURL command to make a GET request to retrieve the data for a specific query run. Ensure you replace `{runId}` with the actual query run ID and `<api-key>` with your valid API key.

```bash
curl --request GET \
  --url https://api.flipsidecrypto.xyz/public/v3/query-runs/{runId}/data \
  --header 'x-api-key: <api-key>'
```

--------------------------------

### Get Latest Query Run Result Metadata (cURL)

Source: https://docs.flipsidecrypto.com/api-reference/queries/get-latest-query-run-result-metadata

Use this cURL command to make a GET request to the Flipside Crypto API to retrieve metadata for the latest query run. Ensure you replace `{id}` with the actual query ID and `<api-key>` with your valid API key.

```bash
curl --request GET \
  --url https://api.flipsidecrypto.xyz/public/v3/queries/{id}/latest/result \
  --header 'x-api-key: <api-key>'
```

--------------------------------

### Execute a swap with execute_swap

Source: https://docs.flipsidecrypto.com/flipspace/mcp/swaps

Create a swap and generate a deposit address. Tokens must be sent to the address within 5 minutes.

```text
Tool: execute_swap
Parameters:
  - intent: Natural language description

  OR structured:
  - tokenIn: Input token assetId
  - tokenOut: Output token assetId
  - amount: Amount to swap
  - fromAddress: Sender address
  - toAddress: Recipient address
```

--------------------------------

### GET ethereum.beacon_chain.fact_deposits

Source: https://docs.flipsidecrypto.com/blockchain-data/ethereum/beacon-chain/fact-deposits

Retrieves information about deposits made to the beacon chain.

```APIDOC
## GET ethereum.beacon_chain.fact_deposits

### Description
This table contains information about the deposits made to the beacon chain.

### Columns
- **SLOT_NUMBER** (NUMBER) - The Beacon Chain slot this block represents.
- **SLOT_TIMESTAMP** (TIMESTAMP_NTZ) - Timestamp of Beacon Chain slot.
- **EPOCH_NUMBER** (NUMBER) - A period of 32 slots, each slot being 12 seconds, totaling 6.4 minutes.
- **DEPOSIT_AMOUNT** (FLOAT) - Decimal adjusted Ether deposit amount.
- **PUBKEY** (TEXT) - Validator public key.
- **SIGNATURE** (TEXT) - Signature of Validator deposit.
- **WITHDRAWAL_CREDENTIALS** (TEXT) - A 32-byte field verifying the destination of valid withdrawals.
- **PROOFS** (VARIANT) - The merkle path to the deposit root.
- **FACT_DEPOSITS_ID** (TEXT) - Primary key - unique identifier for each row.
- **INSERTED_TIMESTAMP** (TIMESTAMP_NTZ) - UTC timestamp when the record was first added to the Flipside database.
- **MODIFIED_TIMESTAMP** (TIMESTAMP_NTZ) - UTC timestamp of the most recent update to this record.
```

--------------------------------

### Combine live and historical data query

Source: https://docs.flipsidecrypto.com/flipsideai/analysis-modes

Example prompt demonstrating how to request both historical trend data and real-time state in a single interaction.

```text
"Show me historical USDC transfer volumes on Arbitrum for the past 90 days,
then use live query to get current balances for the top 10 holders"
```

--------------------------------

### GET /websites/flipsidecrypto/ez_bridge_protocol_metrics_daily

Source: https://docs.flipsidecrypto.com/blockchain-data/crosschain/stats/ez-bridge-protocol-metrics-daily

Retrieves daily aggregated cross-chain bridging metrics.

```APIDOC
## GET /websites/flipsidecrypto/ez_bridge_protocol_metrics_daily

### Description
An aggregated daily view of cross-chain bridging metrics, including volume, distinct addresses and unique transactions grouped by blockchain and bridge protocol.

### Method
GET

### Endpoint
/websites/flipsidecrypto/ez_bridge_protocol_metrics_daily

### Parameters
#### Query Parameters
- **blockchain** (TEXT) - Optional - Blockchain, Network, or Platform the transaction or event occurs on.
- **protocol** (TEXT) - Optional - The platform or protocol from which the bridge transaction or event originates.
- **block_date** (DATE) - Optional - The date of the block timestamp of this transaction in UTC.

### Response
#### Success Response (200)
- **BLOCKCHAIN** (TEXT) - Blockchain, Network, or Platform the transaction or event occurs on.
- **PROTOCOL** (TEXT) - The platform or protocol from which the bridge transaction or event originates.
- **BLOCK_DATE** (DATE) - The date of the block timestamp of this transaction in UTC.
- **TOTAL_INBOUND_VOLUME** (FLOAT) - Total inbound volume.
- **DISTINCT_INBOUND_ADDRESSES** (NUMBER) - Distinct inbound addresses.
- **DISTINCT_INBOUND_TRANSACTIONS** (NUMBER) - Distinct inbound transactions.
- **TOTAL_OUTBOUND_VOLUME** (FLOAT) - Total outbound volume.
- **DISTINCT_OUTBOUND_ADDRESSES** (NUMBER) - Distinct outbound addresses.
- **DISTINCT_OUTBOUND_TRANSACTIONS** (NUMBER) - Distinct outbound transactions.
- **NET_VOLUME** (FLOAT) - Net volume.
- **GROSS_VOLUME** (FLOAT) - Gross volume.
- **EZ_BRIDGE_PROTOCOL_METRICS_DAILY_ID** (TEXT) - Unique identifier for the record.
- **INSERTED_TIMESTAMP** (TIMESTAMP_NTZ) - The UTC timestamp at which the row was inserted into the table.
- **MODIFIED_TIMESTAMP** (TIMESTAMP_NTZ) - The UTC timestamp at which the row was last modified.

#### Response Example
{
  "example": "{\"BLOCKCHAIN\": \"Ethereum\", \"PROTOCOL\": \"Uniswap\", \"BLOCK_DATE\": \"2023-10-27\", \"TOTAL_INBOUND_VOLUME\": 1000000.50, \"DISTINCT_INBOUND_ADDRESSES\": 500, \"DISTINCT_INBOUND_TRANSACTIONS\": 1000, \"TOTAL_OUTBOUND_VOLUME\": 950000.75, \"DISTINCT_OUTBOUND_ADDRESSES\": 480, \"DISTINCT_OUTBOUND_TRANSACTIONS\": 950, \"NET_VOLUME\": 50000.00, \"GROSS_VOLUME\": 1950000.00, \"EZ_BRIDGE_PROTOCOL_METRICS_DAILY_ID\": \"abc123xyz789\", \"INSERTED_TIMESTAMP\": \"2023-10-28T10:00:00Z\", \"MODIFIED_TIMESTAMP\": \"2023-10-28T10:00:00Z\"}"
```

--------------------------------

### Verify Database Existence

Source: https://docs.flipsidecrypto.com/snowflake-data-shares/troubleshooting

List databases matching a specific pattern to confirm the share is mounted correctly.

```sql
Object 'ETHEREUM_CORE.ETHEREUM.CORE.FACT_TRANSACTIONS' does not exist
```

```sql
SHOW DATABASES LIKE '%ETHEREUM%';
```

--------------------------------

### GET crosschain.chain_stats.ez_optimism_metrics_daily

Source: https://docs.flipsidecrypto.com/blockchain-data/crosschain/chain-stats/ez-optimism-metrics-daily

Retrieves daily aggregated metrics for the Optimism blockchain.

```APIDOC
## GET crosschain.chain_stats.ez_optimism_metrics_daily

### Description
Retrieves daily aggregated metrics for the Optimism blockchain, including transaction counts, fees, DEX volumes, bridge flows, CEX flows, and TVL. Data is provided at the daily level (YYYY-MM-DD).

### Method
GET

### Endpoint
crosschain.chain_stats.ez_optimism_metrics_daily

### Response
#### Success Response (200)
- **DAY_** (DATE) - The date of the metrics
- **ACTIVE_USERS_COUNT** (NUMBER) - Total active users
- **ACTIVE_QUALITY_USERS_COUNT** (NUMBER) - Active users with Flipside score >= 4
- **TRANSACTION_COUNT** (NUMBER) - Total transaction count
- **QUALITY_TRANSACTION_COUNT** (NUMBER) - Transaction count from quality users
- **TOTAL_FEES** (FLOAT) - Total fees in native units
- **TOTAL_FEES_USD** (FLOAT) - Total fees in USD
- **QUALITY_TOTAL_FEES** (FLOAT) - Quality user fees in native units
- **QUALITY_TOTAL_FEES_USD** (FLOAT) - Quality user fees in USD
- **STABLECOIN_TRANSFER_VOLUME_USD** (FLOAT) - Stablecoin transfer volume in USD
- **IN_UNIT_TOTAL_TRANSFER_VOLUME** (FLOAT) - Total transfer volume in native units
- **TOTAL_TRANSFER_VOLUME_USD** (FLOAT) - Total transfer volume in USD
- **IN_UNIT_QUALITY_TOTAL_TRANSFER_VOLUME** (FLOAT) - Quality user transfer volume in native units
- **QUALITY_TOTAL_TRANSFER_VOLUME_USD** (FLOAT) - Quality user transfer volume in USD
- **CEX_WITHDRAWAL_VOLUME_USD** (FLOAT) - CEX withdrawal volume in USD
- **CEX_WITHDRAWAL_TX_COUNT** (NUMBER) - CEX withdrawal transaction count
- **CEX_UNIQUE_WITHDRAWING_ADDRESSES** (NUMBER) - Unique CEX withdrawing addresses
- **CEX_DEPOSIT_VOLUME_USD** (FLOAT) - CEX deposit volume in USD
- **CEX_DEPOSIT_TX_COUNT** (NUMBER) - CEX deposit transaction count
- **CEX_UNIQUE_DEPOSITING_ADDRESSES** (NUMBER) - Unique CEX depositing addresses
- **CEX_NET_FLOW_USD** (FLOAT) - CEX net flow in USD
- **CHAIN_GROSS_DEX_VOLUME_USD** (FLOAT) - Gross DEX volume in USD
- **CHAIN_SWAP_COUNT** (NUMBER) - Total swap count
- **CHAIN_SWAPPER_COUNT** (NUMBER) - Total swapper count
- **TVL_USD** (FLOAT) - Total Value Locked in USD
- **IN_UNIT_TVL** (FLOAT) - Total Value Locked in native units
- **BRIDGE_INBOUND_VOLUME_USD** (FLOAT) - Bridge inbound volume in USD
- **BRIDGE_INBOUND_ADDRESSES** (NUMBER) - Bridge inbound addresses
- **BRIDGE_INBOUND_TX_COUNT** (NUMBER) - Bridge inbound transaction count
- **BRIDGE_OUTBOUND_VOLUME_USD** (FLOAT) - Bridge outbound volume in USD
- **BRIDGE_OUTBOUND_ADDRESSES** (NUMBER) - Bridge outbound addresses
- **BRIDGE_OUTBOUND_TX_COUNT** (NUMBER) - Bridge outbound transaction count
- **BRIDGE_GROSS_VOLUME_USD** (FLOAT) - Bridge gross volume in USD
- **BRIDGE_NET_INBOUND_USD** (FLOAT) - Bridge net inbound volume in USD
```

--------------------------------

### Deploy a Skill

Source: https://docs.flipsidecrypto.com/flipspace/cli/skills

Push your skill configuration to make it available for use. This command deploys the skill to the Flipside platform.

```bash
flipside skills push my_skill.yaml
```

--------------------------------

### GET crosschain.chain_stats.ez_near_metrics_daily

Source: https://docs.flipsidecrypto.com/blockchain-data/crosschain/chain-stats/ez-near-metrics-daily

Retrieves daily aggregated metrics for the Near blockchain.

```APIDOC
## GET crosschain.chain_stats.ez_near_metrics_daily

### Description
Retrieves daily aggregated metrics for the Near blockchain, including transaction activity, fees, DEX volumes, bridge flows, CEX flows, and TVL data. Metrics are calculated at the daily level (YYYY-MM-DD).

### Columns
- **DAY_** (DATE) - DAY_ column
- **ACTIVE_USERS_COUNT** (NUMBER) - ACTIVE_USERS_COUNT column
- **ACTIVE_QUALITY_USERS_COUNT** (NUMBER) - ACTIVE_QUALITY_USERS_COUNT column
- **TRANSACTION_COUNT** (NUMBER) - TRANSACTION_COUNT column
- **QUALITY_TRANSACTION_COUNT** (NUMBER) - QUALITY_TRANSACTION_COUNT column
- **TOTAL_FEES** (FLOAT) - TOTAL_FEES column
- **TOTAL_FEES_USD** (FLOAT) - TOTAL_FEES_USD column
- **QUALITY_TOTAL_FEES** (FLOAT) - QUALITY_TOTAL_FEES column
- **QUALITY_TOTAL_FEES_USD** (FLOAT) - QUALITY_TOTAL_FEES_USD column
- **STABLECOIN_TRANSFER_VOLUME_USD** (FLOAT) - STABLECOIN_TRANSFER_VOLUME_USD column
- **IN_UNIT_TOTAL_TRANSFER_VOLUME** (FLOAT) - IN_UNIT_TOTAL_TRANSFER_VOLUME column
- **TOTAL_TRANSFER_VOLUME_USD** (FLOAT) - TOTAL_TRANSFER_VOLUME_USD column
- **IN_UNIT_QUALITY_TOTAL_TRANSFER_VOLUME** (FLOAT) - IN_UNIT_QUALITY_TOTAL_TRANSFER_VOLUME column
- **QUALITY_TOTAL_TRANSFER_VOLUME_USD** (FLOAT) - QUALITY_TOTAL_TRANSFER_VOLUME_USD column
- **CEX_WITHDRAWAL_VOLUME_USD** (FLOAT) - CEX_WITHDRAWAL_VOLUME_USD column
- **CEX_WITHDRAWAL_TX_COUNT** (NUMBER) - CEX_WITHDRAWAL_TX_COUNT column
- **CEX_UNIQUE_WITHDRAWING_ADDRESSES** (NUMBER) - CEX_UNIQUE_WITHDRAWING_ADDRESSES column
- **CEX_DEPOSIT_VOLUME_USD** (FLOAT) - CEX_DEPOSIT_VOLUME_USD column
- **CEX_DEPOSIT_TX_COUNT** (NUMBER) - CEX_DEPOSIT_TX_COUNT column
- **CEX_UNIQUE_DEPOSITING_ADDRESSES** (NUMBER) - CEX_UNIQUE_DEPOSITING_ADDRESSES column
- **CEX_NET_FLOW_USD** (FLOAT) - CEX_NET_FLOW_USD column
- **CHAIN_GROSS_DEX_VOLUME_USD** (FLOAT) - CHAIN_GROSS_DEX_VOLUME_USD column
- **CHAIN_SWAP_COUNT** (NUMBER) - CHAIN_SWAP_COUNT column
- **CHAIN_SWAPPER_COUNT** (NUMBER) - CHAIN_SWAPPER_COUNT column
- **TVL_USD** (FLOAT) - TVL_USD column
- **IN_UNIT_TVL** (FLOAT) - IN_UNIT_TVL column
- **BRIDGE_INBOUND_VOLUME_USD** (FLOAT) - BRIDGE_INBOUND_VOLUME_USD column
- **BRIDGE_INBOUND_ADDRESSES** (NUMBER) - BRIDGE_INBOUND_ADDRESSES column
- **BRIDGE_INBOUND_TX_COUNT** (NUMBER) - BRIDGE_INBOUND_TX_COUNT column
- **BRIDGE_OUTBOUND_VOLUME_USD** (FLOAT) - BRIDGE_OUTBOUND_VOLUME_USD column
- **BRIDGE_OUTBOUND_ADDRESSES** (NUMBER) - BRIDGE_OUTBOUND_ADDRESSES column
- **BRIDGE_OUTBOUND_TX_COUNT** (NUMBER) - BRIDGE_OUTBOUND_TX_COUNT column
- **BRIDGE_GROSS_VOLUME_USD** (FLOAT) - BRIDGE_GROSS_VOLUME_USD column
- **BRIDGE_NET_INBOUND_USD** (FLOAT) - BRIDGE_NET_INBOUND_USD column
```

--------------------------------

### GET /crosschain/chain_stats/ez_polygon_address_metrics

Source: https://docs.flipsidecrypto.com/blockchain-data/crosschain/chain-stats/ez-polygon-address-metrics

Retrieves aggregated on-chain metrics for Polygon addresses.

```APIDOC
## GET /crosschain/chain_stats/ez_polygon_address_metrics

### Description
Retrieves user-level aggregated metrics for Polygon blockchain including transaction activity, DeFi interactions, staking behavior, NFT activity, and governance participation.

### Method
GET

### Endpoint
/crosschain/chain_stats/ez_polygon_address_metrics

### Response
#### Success Response (200)
- **ADDRESS** (TEXT) - Address identifier
- **N_COMPLEX_TXN** (NUMBER) - Count of complex transactions
- **N_CONTRACTS** (NUMBER) - Count of unique contracts interacted with
- **N_TXN** (NUMBER) - Total transaction count
- **N_DAYS_ACTIVE** (NUMBER) - Number of days active
- **N_BRIDGE_IN** (NUMBER) - Count of bridge-in events
- **N_BRIDGES** (NUMBER) - Count of unique bridges used
- **N_CEX_WITHDRAWALS** (NUMBER) - Count of CEX withdrawals
- **NET_TOKEN_ACCUMULATE** (NUMBER) - Net token accumulation value
- **N_OTHER_DEFI** (NUMBER) - Count of other DeFi interactions
- **N_LP_ADDS** (NUMBER) - Count of liquidity provider additions
- **N_LP_POOLS** (NUMBER) - Count of unique LP pools
- **N_SWAP_TX** (NUMBER) - Count of swap transactions
- **N_SWAPS** (NUMBER) - Count of unique swaps
- **N_STAKE_TX** (NUMBER) - Count of staking transactions
- **N_VALIDATORS** (NUMBER) - Count of unique validators
- **NET_STAKE_ACCUMULATE** (NUMBER) - Net stake accumulation value
- **N_GOV_VOTES** (NUMBER) - Count of governance votes
- **N_RESTAKES** (NUMBER) - Count of restaking events
- **N_NFT_MINTS** (NUMBER) - Count of NFT mints
- **N_NFT_COLLECTIONS** (NUMBER) - Count of unique NFT collections
- **N_NFT_TRADES** (NUMBER) - Count of NFT trades
- **N_NFT_IDS** (NUMBER) - Count of unique NFT IDs
- **N_NFT_LISTS** (NUMBER) - Count of NFT listings
- **N_NFT_BUYS** (NUMBER) - Count of NFT purchases
```

--------------------------------

### GET /crosschain/chain_stats/ez_ethereum_allowlist

Source: https://docs.flipsidecrypto.com/blockchain-data/crosschain/chain-stats/ez-ethereum-allowlist

Retrieves the schema and column definitions for the ez_ethereum_allowlist table.

```APIDOC
## GET /crosschain/chain_stats/ez_ethereum_allowlist

### Description
Retrieves the schema definition for the ez_ethereum_allowlist table, which contains verified tokens for the Ethereum blockchain. The data includes an asset tracking column to categorize tokens as ETH, BTC, USD, or alt coins.

### Method
GET

### Endpoint
/crosschain/chain_stats/ez_ethereum_allowlist

### Columns
- **BLOCKCHAIN** (TEXT) - BLOCKCHAIN column
- **TOKEN_ADDRESS** (TEXT) - TOKEN_ADDRESS column
- **SYMBOL** (TEXT) - SYMBOL column
- **TRACKS_ASSET** (TEXT) - TRACKS_ASSET column (indicates ETH, BTC, USD, or alt coin)
```

--------------------------------

### GET /cosmos/core/dim_labels

Source: https://docs.flipsidecrypto.com/blockchain-data/cosmos/core/dim-labels

Retrieves the schema and column definitions for the dim_labels view.

```APIDOC
## GET /cosmos/core/dim_labels

### Description
Returns the schema definition and column metadata for the dim_labels view, which contains address identifiers and classification labels.

### Method
GET

### Endpoint
/cosmos/core/dim_labels

### Response
#### Success Response (200)
- **BLOCKCHAIN** (TEXT) - Always 'Cosmos'.
- **CREATOR** (TEXT) - Name of the label creator.
- **ADDRESS** (TEXT) - Unique wallet, validator, or token address.
- **LABEL_TYPE** (TEXT) - Broad category of the label.
- **LABEL_SUBTYPE** (TEXT) - Detailed classification of the label.
- **LABEL** (TEXT) - The name of the address.
- **PROJECT_NAME** (TEXT) - Project associated with the label.
- **DIM_LABELS_ID** (TEXT) - Unique row identifier.
- **INSERTED_TIMESTAMP** (TIMESTAMP_NTZ) - UTC insertion timestamp.
- **MODIFIED_TIMESTAMP** (TIMESTAMP_NTZ) - UTC last modified timestamp.
```

--------------------------------

### Incremental Processing with Checkpoint Table

Source: https://docs.flipsidecrypto.com/snowflake-data-shares/query-optimization

Demonstrates how to implement incremental data processing by creating a checkpoint table to track the last processed timestamp and querying new data accordingly.

```sql
-- Track last processed timestamp
CREATE OR REPLACE TABLE my_checkpoint (
    table_name VARCHAR,
    last_processed_timestamp TIMESTAMP_NTZ
);
```

```sql
-- Incremental query
SELECT *
FROM ethereum.core.fact_transactions
WHERE block_timestamp > (
    SELECT last_processed_timestamp
    FROM my_checkpoint
    WHERE table_name = 'fact_transactions'
)
AND block_timestamp <= CURRENT_TIMESTAMP() - INTERVAL '10 minutes' -- Buffer for late-arriving data
ORDER BY block_timestamp;
```

--------------------------------

### Get Skill

Source: https://docs.flipsidecrypto.com/api-reference/skills/get-skill

Retrieves details for a specific skill using its identifier.

```APIDOC
## GET /public/v3/skills/{identifier}

### Description
Retrieves details for a specific skill using its unique identifier (UUID or slug).

### Method
GET

### Endpoint
/public/v3/skills/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - Skill UUID or slug. Minimum length: 1.

#### Request Headers
- **x-api-key** (string) - Required - Your API key for authentication.

### Request Example
```bash
curl --request GET \
  --url https://api.flipsidecrypto.xyz/public/v3/skills/{identifier} \
  --header 'x-api-key: <api-key>'
```

### Response
#### Success Response (200)
Returns a JSON object containing the skill's details.

- **id** (string<uuid>) - required - Unique identifier of the skill.
- **name** (string) - required - Name of the skill. Max length: 255.
- **slug** (string) - required - URL-friendly identifier for the skill. Max length: 255. Pattern: `^[a-z0-9_]+$`.
- **description** (string) - required - Description of the skill. Max length: 1000.
- **knowledge** (string) - required - Knowledge domain of the skill. Minimum length: 1.
- **tools** (string[] | null) - required - List of tools associated with the skill.
- **subAgents** (string[] | null) - required - List of sub-agents. Max length: 255. Pattern: `^([a-z0-9_-]+\/)?[a-z0-9_]+$`.
- **organizationId** (string<uuid>) - required - The ID of the organization the skill belongs to.
- **createdById** (string<uuid>) - required - The ID of the user who created the skill.
- **updatedById** (string<uuid>) - required - The ID of the user who last updated the skill.
- **createdAt** (string<date-time>) - required - Timestamp of when the skill was created.
- **updatedAt** (string<date-time>) - required - Timestamp of when the skill was last updated.
- **sections** (object) - Details about skill sections.
- **userAgent** (enum<string> | null) - The user agent associated with the skill. Available options: `web`, `cli`, `internal-cli`, `api`, `slack`, `discord`, `telegram`, `schedule`, `unknown`, `null`.
- **organizationSlug** (string) - The slug of the organization.
- **lastUsedAt** (string<date-time> | null) - Timestamp of when the skill was last used.

#### Response Example
```json
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "knowledge": "<string>",
  "tools": [
    "<string>"
  ],
  "subAgents": [
    "<string>"
  ],
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sections": {},
  "userAgent": "web",
  "organizationSlug": "<string>",
  "lastUsedAt": "2023-11-07T05:31:56Z"
}
```
```

--------------------------------

### Create and Run a SQL Query with Flipside CLI

Source: https://docs.flipsidecrypto.com/flipspace/cli

Creates a new SQL query and immediately executes it. Ensure your query syntax is correct for the target blockchain data.

```bash
# Create and run a query
flipside query create "SELECT * FROM ethereum.core.fact_transactions LIMIT 100"
```

--------------------------------

### Analyze Block Metrics with SQL

Source: https://docs.flipsidecrypto.com/blockchain-data/ethereum/core/fact-blocks

Example queries for calculating hourly gas utilization and identifying high-gas-usage blocks. Replace <blockchain_name> with the specific chain identifier.

```sql
-- Average gas price and utilization by hour
SELECT 
    DATE_TRUNC('hour', block_timestamp) AS hour,
    AVG(gas_used / gas_limit) AS avg_gas_utilization,
    AVG(base_fee_per_gas) AS avg_base_fee,
    COUNT(*) AS blocks_count,
    SUM(tx_count) AS total_transactions
FROM <blockchain_name>.core.fact_blocks
WHERE block_timestamp >= CURRENT_DATE - 7
GROUP BY 1
ORDER BY 1 DESC;

-- Identify high-value blocks by total gas used
SELECT 
    block_number,
    block_timestamp,
    tx_count,
    gas_used,
    gas_limit,
    (gas_used::FLOAT / gas_limit) AS utilization_rate,
    miner
FROM <blockchain_name>.core.fact_blocks
WHERE block_timestamp >= CURRENT_DATE - 1
ORDER BY gas_used DESC
LIMIT 100;
```

--------------------------------

### GET /public/v3/skills

Source: https://docs.flipsidecrypto.com/api-reference/skills/list-skills

Retrieves a paginated list of skills available on the platform.

```APIDOC
## GET /public/v3/skills

### Description
Retrieves a paginated list of skills. Supports filtering by ownership, creator, and search queries, as well as sorting options.

### Method
GET

### Endpoint
https://api.flipsidecrypto.xyz/public/v3/skills

### Parameters
#### Header Parameters
- **x-api-key** (string) - Required - API key for authentication

#### Query Parameters
- **limit** (string) - Optional - Maximum number of results (default: 200, max: 200)
- **offset** (string) - Optional - Number of results to skip (default: 0)
- **search** (string) - Optional - Search query (matches name, slug, description)
- **sortBy** (enum) - Optional - Sort field (default: updated). Options: updated, created, name
- **sortDirection** (enum) - Optional - Sort direction (default: desc). Options: asc, desc
- **ownership** (enum) - Optional - Filter by ownership (default: all). Options: all, owned, granted
- **createdById** (string) - Optional - Filter by creator user ID

### Response
#### Success Response (200)
- **skills** (object[]) - List of skill objects
- **total** (number) - Total count of skills
- **limit** (number) - Limit applied to the request
- **offset** (number) - Offset applied to the request

#### Response Example
{
  "skills": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "knowledge": "<string>",
      "tools": ["<string>"],
      "subAgents": ["<string>"],
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "sections": {},
      "userAgent": "web",
      "organizationSlug": "<string>",
      "lastUsedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}
```

--------------------------------

### GET /public/v3/automations

Source: https://docs.flipsidecrypto.com/api-reference/automations/list-automations

Retrieves a paginated list of automations available to the user.

```APIDOC
## GET /public/v3/automations

### Description
Retrieves a paginated list of automations. Supports filtering, searching, and sorting.

### Method
GET

### Endpoint
https://api.flipsidecrypto.xyz/public/v3/automations

### Parameters
#### Query Parameters
- **include** (enum) - Optional - Available options: `latestRun`
- **limit** (string) - Optional - Maximum number of results (default: 200, max: 200)
- **offset** (string) - Optional - Number of results to skip (default: 0)
- **search** (string) - Optional - Search query (matches name, description)
- **sortBy** (enum) - Optional - Sort field. Available options: `updated`, `created`, `name`
- **sortDirection** (enum) - Optional - Sort direction. Available options: `asc`, `desc`
- **ownership** (enum) - Optional - Ownership filter. Available options: `all`, `owned`, `granted`
- **createdById** (string) - Optional - Filter by creator user ID

### Request Example
curl --request GET \
  --url https://api.flipsidecrypto.xyz/public/v3/automations \
  --header 'x-api-key: <api-key>'

### Response
#### Success Response (200)
- **workflows** (object[]) - List of automation workflows
- **total** (number) - Total count of records
- **limit** (number) - Limit applied to the request
- **offset** (number) - Offset applied to the request

#### Response Example
{
  "workflows": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "cadence": {
        "type": "daily",
        "time": "<string>"
      },
      "inputSchema": {},
      "clonedFromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lastRunAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "userAgent": "web"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}
```

--------------------------------

### Requesting a table schema explanation

Source: https://docs.flipsidecrypto.com/flipsideai/data-and-results

Use this prompt to understand the columns available in a specific table.

```text
"What columns are in the ethereum.defi.ez_dex_swaps table?"
```
Tokens:
Raw