Perform Contract Audit

This endpoint performs an audit on a specified contract, returning detailed audit data including safety levels, compiler info, and more.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

networkId

integer <int64>

required

Network ID

Example:

address

string

required

Account address

>= 42 characters<= 42 characters

Example:

0xf55639a4d0cf6ae63271fa43cc02b39710688380

Responses

🟢200OK

application/json

Body

$schema

string <uri>

read-onlyoptional

A URL to the JSON Schema for this object.

Example:

https://api.unpack.dev/schemas/Report.json

audit

object (Audit)

required

Detailed information of the audit.

compilerVersion

object (SemanticVersion)

required

Version of the compiler used in the audit.

detectors

object

required

Findings of the detectors categorized by impact level.

provider

string

required

Provider of the audit.

safe

boolean

required

Indicates if the contract is safe.

stats

object (DetectorStats)

required

Statistical data of the audit findings.

compiler

object (Compiler)

required

Compiler information used in the audit.

auxVerified

boolean

required

Indicates if auxiliary data is verified.

compilerVersion

object (SemanticVersion)

required

Version of the compiler used.

levenshteinDistance

integer <int64>

required

Levenshtein distance of the compiler version.

partial

boolean

required

Indicates if the verification is partial.

verified

boolean

required

Indicates if the compiler is verified.

completedStates

array[string]

required

List of completed states in the audit process.

contractAddress

string

required

Contract address being audited.

createdAt

string <date-time>

required

Timestamp of when the audit was created.

failedStates

array[string]

required

List of failed states in the audit process.

string

required

Unique identifier of the report.

networkId

integer <int64>

required

Network ID associated with the report.

partial

boolean

required

Indicates if the audit is partially complete.

processed

boolean

required

Indicates if the audit has been processed.

safe

boolean

required

Overall safety status of the contract.

safetyLevel

string

required

Safety level classification of the contract.

safetyScore

number <double>

required

Safety score assigned to the contract.

updatedAt

string <date-time>

required

Timestamp of the last update to the audit.

Example

{
  "$schema": "https://api.unpack.dev/schemas/Report.json",
  "audit": {
    "compilerVersion": {
      "major": 0,
      "minor": 0,
      "patch": 0,
      "revision": "string"
    },
    "detectors": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "provider": "string",
    "safe": true,
    "stats": {
      "high": 0,
      "informational": 0,
      "low": 0,
      "medium": 0
    }
  },
  "compiler": {
    "auxVerified": true,
    "compilerVersion": {
      "major": 0,
      "minor": 0,
      "patch": 0,
      "revision": "string"
    },
    "levenshteinDistance": 0,
    "partial": true,
    "verified": true
  },
  "completedStates": [
    "string"
  ],
  "contractAddress": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "failedStates": [
    "string"
  ],
  "id": "string",
  "networkId": 0,
  "partial": true,
  "processed": true,
  "safe": true,
  "safetyLevel": "string",
  "safetyScore": 0,
  "updatedAt": "2019-08-24T14:15:22Z"
}

🔴500Error

Request

Request samples

Responses