curl --request POST \
--url https://app.blockgence.com/v1/audit \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"repo": "<string>",
"commit": "<string>",
"level": "automated",
"files": [
"<string>"
],
"spec": "<string>",
"project": "<string>"
}
'import requests
url = "https://app.blockgence.com/v1/audit"
payload = {
"repo": "<string>",
"commit": "<string>",
"level": "automated",
"files": ["<string>"],
"spec": "<string>",
"project": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repo: '<string>',
commit: '<string>',
level: 'automated',
files: ['<string>'],
spec: '<string>',
project: '<string>'
})
};
fetch('https://app.blockgence.com/v1/audit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.blockgence.com/v1/audit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repo' => '<string>',
'commit' => '<string>',
'level' => 'automated',
'files' => [
'<string>'
],
'spec' => '<string>',
'project' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.blockgence.com/v1/audit"
payload := strings.NewReader("{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.blockgence.com/v1/audit")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/audit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Request a smart contract review
Registers a smart contract review request for your organization.
Request body (JSON).
repo(required): public GitHub repository,https://github.com/<owner>/<repo>. Private repositories and compressed files are not accepted yet.commit(required): full commit hash (40 hex). The whole report refers to that commit.level:automated(default),assistedoraudit. Theauditlevel requiresspec.files: paths or patterns relative to the repository; a leading!excludes. Up to 50. Default:src/**/*.solwithout tests, scripts orlib/.spec: specification or design document, up to 50,000 characters. Optional, except at theauditlevel.project: name for the dashboard; default, the repository name.
Response. 201 with {demo, note, audit_id, audit, queue}. audit has the shape of a row of
GET /v1/audit, with run.state: "queued" and requested: true. It is a real review of your organization
(demo: false), visible only to it.
Availability. Audit execution will be available soon. Until then, the review is registered in the queue but
does not run: queue.state is not_enqueued and note says so. Once execution is available, queue.state
will be enqueued. The sections of the review are empty, except deploy and notas: they are not filled with
example data, which would be invented findings about your code. An empty section does not mean “no findings”.
Errors. With body {"error": …, "detail": …}:
400:bad_repo,bad_commit,bad_level,bad_files,spec_requiredorspec_too_long.403 org_required: an API key without an organization cannot request reviews.403 read_only: the role is read-only.409 too_many_queued: the organization already has 50 queued reviews that have not run.503 queue_unavailable: the review could not be queued; nothing is registered.
Cost: free.
curl --request POST \
--url https://app.blockgence.com/v1/audit \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"repo": "<string>",
"commit": "<string>",
"level": "automated",
"files": [
"<string>"
],
"spec": "<string>",
"project": "<string>"
}
'import requests
url = "https://app.blockgence.com/v1/audit"
payload = {
"repo": "<string>",
"commit": "<string>",
"level": "automated",
"files": ["<string>"],
"spec": "<string>",
"project": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repo: '<string>',
commit: '<string>',
level: 'automated',
files: ['<string>'],
spec: '<string>',
project: '<string>'
})
};
fetch('https://app.blockgence.com/v1/audit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.blockgence.com/v1/audit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repo' => '<string>',
'commit' => '<string>',
'level' => 'automated',
'files' => [
'<string>'
],
'spec' => '<string>',
'project' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.blockgence.com/v1/audit"
payload := strings.NewReader("{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.blockgence.com/v1/audit")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/audit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Authorizations
Headers
Body
Response
Review registered.