diff --git a/content/redirects.yml b/content/redirects.yml index 1bedcde92..f76e390dd 100644 --- a/content/redirects.yml +++ b/content/redirects.yml @@ -1533,9 +1533,14 @@ redirects: # Portfolio # Beta APIs section was removed; its only endpoint (get-transaction-history-by-address) - # now lives under Portfolio API. Redirect the old beta URLs to the new Portfolio home. + # was later moved to Portfolio API and then removed in favor of Transfers By Wallet. + # Redirect the old beta URLs and the former Portfolio URL to Transfers By Wallet. - source: /docs/data/beta-apis/beta-api-endpoints/beta-api-endpoints/get-transaction-history-by-address - destination: /docs/data/portfolio-apis/portfolio-api-endpoints/portfolio-api-endpoints/get-transaction-history-by-address + destination: /docs/data/portfolio-apis/portfolio-api-endpoints/portfolio-api-endpoints/get-transfers-by-address + permanent: true + + - source: /docs/data/portfolio-apis/portfolio-api-endpoints/portfolio-api-endpoints/get-transaction-history-by-address + destination: /docs/data/portfolio-apis/portfolio-api-endpoints/portfolio-api-endpoints/get-transfers-by-address permanent: true - source: /docs/data/beta-apis diff --git a/src/openapi/portfolio/portfolio.yaml b/src/openapi/portfolio/portfolio.yaml index bfa3d70ed..15582bcac 100644 --- a/src/openapi/portfolio/portfolio.yaml +++ b/src/openapi/portfolio/portfolio.yaml @@ -33,12 +33,6 @@ paths: post: $ref: "./transfers/by-address.yaml" #################################################### - # Transaction History API - #################################################### - "/{apiKey}/transactions/history/by-address": - post: - $ref: "./transactions/history/by-address.yaml" - #################################################### # NFT APIs (Deprecated / Older) #################################################### # NOTE: This should be hidden from the user. @@ -337,30 +331,6 @@ components: required: - addresses - ByAddressRequestWith1AddressAnd2Networks: - type: object - properties: - addresses: - type: array - description: > - Array of address and networks pairs (limit 1 pairs, max 2 networks). Networks should match network enums. - items: - $ref: "#/components/schemas/AddressItemTransactionHistory" - before: - type: string - description: "The cursor that points to the previous set of results." - after: - type: string - description: "The cursor that points to the end of the current set of results." - limit: - type: integer - description: "Sets the maximum number of items per page (Max: 50)" - default: 25 - pageKey: - $ref: "../nft/nft.yaml#/components/schemas/pageKey" - required: - - addresses - ByAddressRequestWith3PairsAnd20Networks: type: object properties: @@ -504,27 +474,6 @@ components: - address - networks - AddressItemTransactionHistory: - type: object - properties: - address: - type: string - description: Wallet address. - example: "0x1E6E8695FAb3Eb382534915eA8d7Cc1D1994B152" - default: "0x1E6E8695FAb3Eb382534915eA8d7Cc1D1994B152" - networks: - type: array - default: - - eth-mainnet - - base-mainnet - items: - type: string - default: eth-mainnet - description: (In BETA and only accepts ETH & BASE mainnets). Network identifier (e.g., eth-mainnet). Find more network enums [here](https://dashboard.alchemy.com/chains) - required: - - address - - networks - AddressItemWith20Maximum: type: object properties: @@ -1220,140 +1169,6 @@ components: # # $ref: '../nft/nft.yaml#/components/schemas/pageKey' # required: # - data - #################################################### - # Transaction History APIs - #################################################### - TransactionHistoryResponse: - type: object - properties: - before: - type: string - description: "The cursor that points to the previous set of results." - after: - type: string - description: "The cursor that points to the end of the current set of results." - totalCount: - type: integer - description: "Total count of the response items." - transactions: - type: array - description: List of transactions by address. - items: - $ref: "#/components/schemas/TransactionHistoryResponseItem" - required: - - transactions - - TransactionHistoryResponseItem: - type: object - properties: - network: - type: string - description: "Network associated with an individual transaction" - hash: - type: string - description: "Transaction hash" - timeStamp: - type: string - description: "(ISO 8601) Timestamp of transaction mining / confirmation" - blockNumber: - type: integer - description: "Block number of transaction mining / confirmation" - blockHash: - type: string - description: "Block hash of transaction mining / confirmation" - nonce: - type: integer - description: "Transaction nonce" - transactionIndex: - type: integer - description: "Position of transaction within a block" - fromAddress: - type: string - description: "From address of transaction (hex string)." - toAddress: - type: string - description: "To address of transaction (hex string). null if contract creation." - contractAddress: - type: string - description: "20 Bytes - The contract address created, if the transaction was a contract creation, otherwise null" - value: - type: string - description: "(uint8) Value of native token value moved within the external transaction" - cumulativeGasUsed: - type: string - description: The total amount of gas used when this transaction was executed in the block. - effectiveGasPrice: - type: string - description: Gas price parameter - gasUsed: - type: string - description: The amount of gas used by this specific transaction alone - logs: - type: array - description: "Array of log objects, which this transaction generated" - items: - $ref: "#/components/schemas/txn_history_log_object" - internalTxns: - type: array - description: "Array of internal transaction objects, which this transaction generated" - items: - $ref: "#/components/schemas/txn_history_trace_object" - - txn_history_trace_object: - type: object - properties: - type: - type: string - description: CALL or CREATE - fromAddress: - type: string - description: 20 Bytes - address of the sender - toAddress: - type: string - description: 20 Bytes - address of the receiver. null when its a contract creation transaction - value: - type: string - description: amount of value for transfer (in hex) - gas: - type: string - description: amount of gas provided for the call (in hex) - gasUsed: - type: string - description: amount of gas used during the call (in hex) - input: - type: string - description: call data - output: - type: string - description: return data - error: - type: string - description: error, if any - revertReason: - type: string - description: solidity revert reason, if any - - txn_history_log_object: - type: object - properties: - contractAddress: - type: string - description: 20 Bytes - contract address from which this log originated. - logIndex: - type: string - description: Integer of the log index position in the block. null when its pending log. - data: - type: string - description: Contains one or more 32 Bytes non-indexed arguments of the log. - removed: - type: boolean - description: "true when the log was removed, due to a chain reorganization. false if its a valid log." - topics: - type: array - items: - type: string - description: "Array of zero to four 32 Bytes DATA of indexed log arguments" - #################################################### # Prices APIs #################################################### diff --git a/src/openapi/portfolio/transactions/history/by-address.yaml b/src/openapi/portfolio/transactions/history/by-address.yaml deleted file mode 100644 index fcf6a655b..000000000 --- a/src/openapi/portfolio/transactions/history/by-address.yaml +++ /dev/null @@ -1,39 +0,0 @@ -summary: Transactions By Wallet (Beta) -description: | - Fetches all historical transactions (internal & external) for multiple wallet addresses and networks. (Currently limited to Ethereum and Base with a limit of 1 address) Returns a list of transaction objects with metadata and log information. - - - Please use [Transfers By Wallet](/docs/data/portfolio-apis/portfolio-api-endpoints/portfolio-api-endpoints/get-transfers-by-address) instead. - - While you can continue using this endpoint for now, it is scheduled for removal. The recommended approach is to migrate to Transfers By Wallet, which has coverage for more chains and provides more complete and consistent results. - - -tags: ["Portfolio API Endpoints"] -parameters: - - $ref: "../../portfolio.yaml#/components/parameters/apiKey" -requestBody: - required: true - content: - application/json: - schema: - $ref: "../../portfolio.yaml#/components/schemas/ByAddressRequestWith1AddressAnd2Networks" -responses: - "200": - description: Successful response! - content: - application/json: - schema: - $ref: "../../portfolio.yaml#/components/schemas/TransactionHistoryResponse" - "400": - description: "Bad Request: Invalid input (e.g., malformed JSON)." - content: - application/json: - schema: - $ref: "../../portfolio.yaml#/components/schemas/ErrorResponse" - "429": - description: "Too Many Requests: Rate limit exceeded." - content: - application/json: - schema: - $ref: "../../portfolio.yaml#/components/schemas/ErrorResponse" -operationId: get-transaction-history-by-address