Get Contract Documentation

GET

https://api.unpack.dev/v1/ast/{networkId}/{address}/docs

Last modified:2024-05-31 11:02:21

OperationId:ast-docs-get

Gets the documentation comments for a contract on a specified network by address. Useful for Solidity smart contract investigations. Documentation comments provide insight into the contract's functionality and design.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.unpack.dev/v1/ast/1/0x5dbad78818d4c8958eff2d5b95b28385a22113cd/docs' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

Body

Example

{
    "$schema": "https://api.unpack.dev/schemas/AstDocs.json",
    "contractAddress": "string",
    "contractId": "string",
    "docs": [
        {
            "id": 0,
            "nodeType": 0,
            "src": {
                "column": 0,
                "end": 0,
                "length": 0,
                "line": 0,
                "parentIndex": 0,
                "start": 0
            },
            "text": "string"
        }
    ],
    "networkId": {}
}

🔴500Error

Modified at 2024-05-31 11:02:21

Get Contract Definitions

Get Contract Enums