{
  "openapi": "3.1.0",
  "info": {
    "title": "Goldrush Wallet API",
    "description": "Quicknode Goldrush Wallet API reference",
    "version": "1.0.0"
  },
  "paths": {
    "/v1/btc-mainnet/address/{walletAddress}/balances_v2": {
      "get": {
        "operationId": "get_v1_btc_mainnet_address_by_walletAddress_balances_v2",
        "summary": "Fetch Bitcoin balance for a non-HD address.",
        "tags": [
          "btc-mainnet"
        ],
        "externalDocs": {
          "description": "Quicknode docs",
          "url": "https://www.quicknode.com/docs/bitcoin/goldrush-wallet-api/v1-btc-mainnet-address-walletAddress-balances_v2"
        },
        "description": "Fetch Bitcoin balance for a non-HD address. Response includes spot prices and other metadata",
        "parameters": [
          {
            "name": "walletAddress",
            "in": "path",
            "schema": {
              "type": "string",
              "description": "The wallet address for which the balances are to be retrieved"
            },
            "required": true,
            "description": "The wallet address for which the balances are to be retrieved"
          },
          {
            "name": "quote-currency",
            "in": "query",
            "schema": {
              "type": "string",
              "description": "The currency to quote the balance values in (e.g., USD, EUR)"
            },
            "description": "The currency to quote the balance values in (e.g., USD, EUR)"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "address": {
                          "type": "string",
                          "description": "The queried Bitcoin address"
                        },
                        "updated_at": {
                          "type": "string",
                          "description": "The timestamp when the data was last updated"
                        },
                        "next_update_at": {
                          "type": "string",
                          "description": "The timestamp for the next scheduled update"
                        },
                        "quote_currency": {
                          "type": "string",
                          "description": "The currency in which the values are quoted"
                        },
                        "chain_id": {
                          "type": "integer",
                          "description": "The unique ID of the blockchain"
                        },
                        "chain_name": {
                          "type": "string",
                          "description": "The name of the blockchain"
                        },
                        "items": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "contract_decimals": {
                                "type": "integer",
                                "description": "The number of decimal places used by the token"
                              },
                              "contract_name": {
                                "type": "string",
                                "description": "The name of the token contract"
                              },
                              "contract_ticker_symbol": {
                                "type": "string",
                                "description": "The ticker symbol of the token contract"
                              },
                              "contract_address": {
                                "type": "string",
                                "description": "The address of the token contract"
                              },
                              "supports_erc": {
                                "type": "array",
                                "items": {},
                                "description": "An array listing the supported ERC standards, if applicable"
                              },
                              "logo_url": {
                                "type": "string",
                                "description": "The URL to the token's logo"
                              },
                              "contract_display_name": {
                                "type": "string",
                                "description": "The display name of the token contract"
                              },
                              "logo_urls": {
                                "type": "object",
                                "properties": {
                                  "token_logo_url": {
                                    "type": "string",
                                    "description": "The URL of the token's logo"
                                  },
                                  "protocol_logo_url": {
                                    "type": "string",
                                    "description": "The URL of the protocol's logo, if available"
                                  },
                                  "chain_logo_url": {
                                    "type": "string",
                                    "description": "The URL of the chain's logo"
                                  }
                                },
                                "description": "An object of URLs to different logo variations of the token"
                              },
                              "last_transferred_at": {
                                "type": "string",
                                "description": "The timestamp when the token was last transferred"
                              },
                              "native_token": {
                                "type": "boolean",
                                "description": "Indicates if the token is the native currency of the blockchain"
                              },
                              "type": {
                                "type": "string",
                                "description": "The type of the token or transaction"
                              },
                              "is_spam": {
                                "type": "boolean",
                                "description": "Indicates if the token is considered spam"
                              },
                              "balance": {
                                "type": "string",
                                "description": "The balance of the token"
                              },
                              "balance_24h": {
                                "type": "string",
                                "description": "The balance of the token 24 hours ago"
                              },
                              "quote_rate": {
                                "type": "number",
                                "description": "The current quoted rate for the token in the given currency"
                              },
                              "quote_rate_24h": {
                                "type": "number",
                                "description": "The quoted rate for the token in the given currency 24 hours ago"
                              },
                              "quote": {
                                "type": "number",
                                "description": "The total quote value of the balance in the given currency"
                              },
                              "pretty_quote": {
                                "type": "string",
                                "description": "The human-readable format of the quote value"
                              },
                              "quote_24h": {
                                "type": "number",
                                "description": "The total quote value 24 hours ago in the given currency"
                              },
                              "pretty_quote_24h": {
                                "type": "string",
                                "description": "The human-readable format of the quote value 24 hours ago"
                              },
                              "protocol_metadata": {
                                "type": "string",
                                "description": "Any additional metadata related to the protocol"
                              },
                              "nft_data": {
                                "type": "string",
                                "description": "NFT data associated with the token, if applicable"
                              }
                            }
                          },
                          "description": "An array of objects containing information about the tokens or transactions associated with the address"
                        },
                        "pagination": {
                          "type": "object",
                          "properties": {
                            "has_more": {
                              "type": "boolean",
                              "description": "The flag indicating if there are more pages of data"
                            },
                            "page_number": {
                              "type": "integer",
                              "description": "The current page number"
                            },
                            "page_size": {
                              "type": "integer",
                              "description": "The number of items per page"
                            },
                            "total_count": {
                              "type": "integer",
                              "description": "The total number of items (nullable)"
                            }
                          },
                          "description": "The pagination details for the response"
                        }
                      },
                      "description": "The main object containing details about the queried Bitcoin transactions"
                    },
                    "error": {
                      "type": "boolean",
                      "description": "Indicates whether an error occurred"
                    },
                    "error_message": {
                      "type": "string",
                      "description": "The error message, if any"
                    },
                    "error_code": {
                      "type": "string",
                      "description": "The error code, if any"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cq/covalent/app/bitcoin/transactions": {
      "get": {
        "operationId": "get_v1_cq_covalent_app_bitcoin_transactions",
        "summary": "Fetch the full transaction history of a Bitcoin wallet",
        "tags": [
          "cq"
        ],
        "externalDocs": {
          "description": "Quicknode docs",
          "url": "https://www.quicknode.com/docs/bitcoin/goldrush-wallet-api/v1-cq-covalent-app-bitcoin-transactions"
        },
        "parameters": [
          {
            "name": "address",
            "in": "query",
            "schema": {
              "type": "string",
              "description": "The address to query transactions for"
            },
            "description": "The address to query transactions for"
          },
          {
            "name": "page-size",
            "in": "query",
            "schema": {
              "type": "integer",
              "description": "The number of results to display per page"
            },
            "description": "The number of results to display per page"
          },
          {
            "name": "page-number",
            "in": "query",
            "schema": {
              "type": "integer",
              "description": "The page number to retrieve for paginated results"
            },
            "description": "The page number to retrieve for paginated results"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "updated_at": {
                          "type": "string",
                          "description": "The timestamp of when the data was last updated"
                        },
                        "items": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "chain_id": {
                                "type": "string",
                                "description": "The ID of the blockchain"
                              },
                              "chain_name": {
                                "type": "string",
                                "description": "The name of the blockchain"
                              },
                              "contract_decimals": {
                                "type": "integer",
                                "description": "The number of decimal places used by the token contract"
                              },
                              "block_hash": {
                                "type": "string",
                                "description": "The hash of the block"
                              },
                              "block_signed_at": {
                                "type": "string",
                                "description": "The timestamp of when the block was signed"
                              },
                              "block_height": {
                                "type": "string",
                                "description": "The height of the block"
                              },
                              "tx_hash": {
                                "type": "string",
                                "description": "The hash of the transaction"
                              },
                              "tx_idx": {
                                "type": "string",
                                "description": "The index of the transaction within the block"
                              },
                              "type": {
                                "type": "string",
                                "description": "The type of transaction (e.g., input or output)"
                              },
                              "address": {
                                "type": "string",
                                "description": "The address associated with the transaction"
                              },
                              "value": {
                                "type": "string",
                                "description": "The value of the transaction"
                              },
                              "quote_rate": {
                                "type": "number",
                                "description": "The exchange rate at the time of the transaction"
                              },
                              "quote": {
                                "type": "number",
                                "description": "The quoted value in USD"
                              },
                              "fees_paid": {
                                "type": "string",
                                "description": "The fees paid for the transaction"
                              },
                              "gas_quote": {
                                "type": "number",
                                "description": "The gas quote for the transaction"
                              },
                              "gas_quote_rate": {
                                "type": "number",
                                "description": "The gas quote rate at the time of the transaction"
                              },
                              "coinbase": {
                                "type": "boolean",
                                "description": "Indicates if the transaction was a coinbase transaction"
                              },
                              "locktime": {
                                "type": "string",
                                "description": "The locktime of the transaction"
                              },
                              "weight": {
                                "type": "string",
                                "description": "The weight of the transaction"
                              }
                            }
                          },
                          "description": "An array of transaction details"
                        },
                        "pagination": {
                          "type": "object",
                          "properties": {
                            "has_more": {
                              "type": "boolean",
                              "description": "Indicates if there are more pages available"
                            },
                            "page_number": {
                              "type": "integer",
                              "description": "The current page number"
                            },
                            "page_size": {
                              "type": "integer",
                              "description": "The number of items per page"
                            },
                            "total_count": {
                              "type": "string",
                              "description": "The total number of items"
                            }
                          },
                          "description": "Pagination details for the response"
                        },
                        "metadata": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "The name of the metadata field"
                              },
                              "type": {
                                "type": "string",
                                "description": "The type of the metadata field"
                              }
                            }
                          },
                          "description": "Additional metadata for the response"
                        }
                      },
                      "description": "The main response object containing the data"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.covalenthq.com",
      "description": "Quicknode Bitcoin"
    }
  ]
}