synternet.insights.cbbtc.requests logo

synternet.insights.cbbtc.requests (cbBTC requests)

In Insights by Synternet

2 user(s)

4 SYNT

Documentation

{ "endpoint": "synternet.cbbtc-dapp.requests", "description": "Fetch and filter cbBTC transaction requests across supported blockchain networks with support for pagination and sorting", "payload": { "network": { "type": "string", "required": false, "description": "The blockchain network to query. If not specified, returns requests from all networks", "enum": ["ethereum", "base", "arbitrum", "solana"] }, "page_size": { "type": "integer", "required": false, "description": "Number of items per page", "default": 10, "min": 1 }, "page": { "type": "integer", "required": false, "description": "Page number to fetch", "default": 1, "min": 1 }, "methods": { "type": "array", "items": { "type": "string" }, "required": false, "description": "Filter by one or more transaction methods/event types", "enum": [ "mint", "burn" ] }, "event_types": { "type": "array", "items": { "type": "string" }, "required": false, "description": "Filter by one or more event types (for backward compatibility)", "enum": [ "mint", "burn" ] }, "min_amount": { "type": "float", "required": false, "description": "Minimum transaction amount in cbBTC", "min": 0 }, "max_amount": { "type": "float", "required": false, "description": "Maximum transaction amount in cbBTC", "min": 0 }, "start_time": { "type": "string", "required": false, "format": "ISO8601", "description": "Start time for filtering (inclusive)", "example": "2024-03-26T00:00:00Z" }, "end_time": { "type": "string", "required": false, "format": "ISO8601", "description": "End time for filtering (inclusive)", "example": "2024-03-26T23:59:59Z" }, "sort_by": { "type": "string", "required": false, "enum": ["timestamp", "method", "amount", "network"], "default": "timestamp", "description": "Field to sort results by" }, "sort_order": { "type": "string", "required": false, "enum": ["asc", "desc"], "default": "desc", "description": "Sort order direction" } }, "response": { "requests": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for the request" }, "transaction_hash": { "type": "string", "description": "Hash of the transaction" }, "block_number": { "type": "integer", "description": "Block number where the transaction was included" }, "method": { "type": "string", "description": "Method name/event type of the transaction", "enum": ["mint", "burn"] }, "amount": { "type": "float", "description": "Transaction amount in cbBTC" }, "usd_amount": { "type": "float", "description": "Transaction amount in USD" }, "src_address": { "type": "string", "description": "Source address (from_address)" }, "dst_address": { "type": "string", "description": "Destination address (to_address)" }, "network": { "type": "string", "description": "Network where the transaction occurred", "enum": ["ethereum", "base", "arbitrum", "solana"] }, "timestamp": { "type": "string", "description": "Timestamp of the transaction", "format": "ISO8601" } } } }, "total_count": { "type": "integer", "description": "Total number of records matching the query" }, "current_page": { "type": "integer", "description": "Current page number" }, "total_pages": { "type": "integer", "description": "Total number of pages available" }, "items_per_page": { "type": "integer", "description": "Number of items in current page" } }, "examples": { "all_networks": { "description": "Fetch requests from all networks", "payload": { "page_size": 50, "page": 1 } }, "single_network": { "description": "Fetch requests from a specific network", "payload": { "network": "ethereum", "page_size": 10, "page": 1 } }, "filtered_request": { "description": "Fetch mint and burn requests with amount filtering", "payload": { "methods": ["mint", "burn"], "min_amount": 1.0, "max_amount": 100.0, "sort_by": "amount", "sort_order": "desc", "page_size": 20, "page": 1 } }, "time_range_request": { "description": "Fetch requests within a time range", "payload": { "methods": ["mint", "burn"], "start_time": "2024-03-01T00:00:00Z", "end_time": "2024-03-26T23:59:59Z", "sort_by": "timestamp", "sort_order": "asc", "page_size": 50 } }, "l2_network_request": { "description": "Fetch mint events from L2 networks", "payload": { "network": "base", "methods": ["mint"], "sort_by": "timestamp", "sort_order": "desc", "page_size": 20 } }, "solana_request": { "description": "Fetch Solana requests with amount filtering", "payload": { "network": "solana", "min_amount": 0.5, "sort_by": "timestamp", "sort_order": "desc", "page_size": 15 } } }, "notes": { "pagination": [ "Default page size is 10 records", "Page numbering starts at 1", "If page is specified without page_size, default page size is used" ], "filtering": [ "All filters are optional and can be combined", "Time filters use ISO8601 format", "Amount filters must be positive numbers", "Methods filter accepts an array of method names and matches any of the specified methods", "Method names are case-sensitive", "Network filter is optional - if not specified, returns requests from all networks", "For backward compatibility, both 'methods' and 'event_types' filters are supported and can be used interchangeably" ], "sorting": [ "Default sort is by timestamp in descending order", "Available sort fields: timestamp, method, amount, network", "Default sort order is descending (desc)", "Secondary sort by timestamp DESC is always applied when primary sort is not timestamp" ], "supported_networks": [ "ethereum - Ethereum mainnet", "base - Base network", "arbitrum - Arbitrum network", "solana - Solana network" ], "event_types": [ "mint - Tokens minted/received on the network", "burn - Tokens burned/sent from the network" ] } }