> For the complete documentation index, see [llms.txt](https://manos-organization.gitbook.io/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manos-organization.gitbook.io/api-docs/solidityscan-sdk.md).

# solidityscan sdk

## Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

## Install your API Access key

You can find your Access Key from your solidityscan [integrations](https://solidityscan.com/integrations) page any time.

Install your access key by using the command below directly.

```
solidityscan config add-update-config --token='youraccesskey'
```

This command will create a configuration file at the default location for your system. If a config file already exists, it will overwrite the accesskey in that file.

## Download or Install the SDK

The best way to interact with our API is to use pip.

{% tabs %}
{% tab title="pip" %}

```
pip install solidityscan
```

{% endtab %}

{% tab title="linux" %}
todo
{% endtab %}

{% tab title="unix" %}
todo
{% endtab %}

{% tab title="windows" %}
todo
{% endtab %}
{% endtabs %}

## Features

***Project Scan***

* Scan your public and private repositories hosted on Github.

***Block Scan***

* Initiate scans on contracts deployed both on Testnets and Mainnets.
* SolidityScan currently supports Ethereum, Binance, Polygon, Avalanche and Fantom.

## Examples

***Perform a Project Scan***

```
solidityscan scan --scan-type="project" -project-url="https://github.com/testrepo" -project-branch="main" -project-name="testname"
```

***Perform a Block Scan***

```
solidityscan scan --scan-type="block" -contract-address="0x633bA1eeDbE63a779Eca6A1EbE86908Ac2710D0b" -contract-chain="mainnet" -contract-platform="etherscan"
```

***Adding or Updating token to config***

```
solidityscan config add-update-config --token='yourtoken'
```

***Setting default error language (defaults to English (en))***

```
solidityscan config add-update-config --error-language='es'
```

## Error codes

```
000x - Errors raised by the server
100x - Errors raised by the SDK
```