Objects Definitions

ScanResultSuccess Object

Stores the results a scan

Field	Type	Description
issues	Array of Issue Objects
status	String	"success"
scan_id	String
num_lines	Integer
severity_counts	Severity Counts Object
score	Integer
timestamp	Integer

Issue Object

Field	Type
title	String
description	String
severity	Severity Enum
snippet	String

ErrorResponse Object

Field	Type	Description
status	String	"failure"
error_message	String	failure reason
scan_id	String

ScanResultInProgress Object

Field	Type
status	String	"in_progress"
scan_id	String

Severity Counts Object

Field	Type
high	int
medium	int
low	int
non_critical	int
gas_optimization	int

Scan Placement Response Object

Field	Type	Description
status	String	"success", "in_progress", "failure"
message	String	If failed, give reason for failure
scan_id	String	Used to retreive scans results from get_scans

Severity Enum

An enum indicating the severity of the of the Issue

Category
high	High flaws can result in the loss of assets or the alteration of data and are typically simple to exploit. Some high flaws can be challenging to attack, but they can have a big impact on how smart contracts work, like giving the public access to essential features
medium	Although medium-level vulnerabilities should be fixed, they cannot result in the loss of assets or the manipulation of data.
low	Low-level flaws are typically caused by bits of unneeded, old code that don't have a big influence on the execution.
non_critical	A non-critical issue refers to a bug or vulnerability that, while potentially inconvenient, does not pose an immediate or severe threat to the security, functionality, or performance of a smart contract.
gas_optimization	The issue identifies unnecessary gas usage.