Skip to content

Setting Up SDK & CLI Tool

The Netlas Python SDK is a software development kit provided by the Netlas team to facilitate the integration of Netlas services into Python applications. The SDK provides a convenient way to interact with the API, performing tasks such as queries, routing and parsing the JSON responses from the Netlas API into Python objects, simplifying the process of integrating Netlas data into Python projects.

To access Netlas using the command line interface, the Netlas team has developed the Netlas CLI Tool. With it, you can use Netlas just like any other command line application. This utility is included in the Netlas Python SDK.

Installation

If you have Python installed, simply use the Python package installer to install the SDK and CLI Tool:

pip install netlas

Or if you already have it installed and want to upgrade to the latest version:

pip install --upgrade netlas

Checking the installation

Now you can interact with the Netlas platform using command netlas.

netlas

Try to get information about your external IP address:

netlas host -a "YOUR_API_KEY"

The same data you should see in the web app if you open https://app.netlas.io/host/

Additional tools

We recommend using the Netlas CLI in conjunction with the jq utility. It is a lightweight and flexible command-line JSON processor, allowing you to perform various manipulations with the output.

Refer to JQ website for installation instructions.

Setting up API Key

There are two ways of API key usage when you work with Netlas CLI (command line interface). The first way is to enter the key each time you enter a command with the -a option. Another way is to save the key using savekey command.

netlas savekey "YOUR_API_KEY"

CLI Usage

Please refer to the built-in help for command and option information. To show help page:

netlas --help

Usage: netlas [OPTIONS] COMMAND [ARGS]...

Options:
  -h, --help  Show this message and exit.

Commands:
  count           Calculate count of query results.
  download        Download data.
  host            Host (ip or domain) information.
  indices         Get available data indices.
  profile         Get user profile data.
  savekey         Save API key to the local system.
  search (query)  Search query.
  stat            Get statistics for query.

To view specific command help use --help key with netlas command, e.g.:

netlas count --help

Usage: netlas count [OPTIONS] QUERYSTRING

  Calculate count of query results.

Options:
  -d, --datatype [response|cert|domain|whois-ip|whois-domain]
                                  Query data type  [default: response]
  -a, --apikey TEXT               User API key (can be saved to system using
                                  command `netlas savekey`)
  -f, --format [json|yaml]        Output format  [default: yaml]
  --server TEXT                   Netlas API server  [default:
                                  https://app.netlas.io]
  --indices TEXT                  Specify comma-separated data index
                                  collections
  -h, --help                      Show this message and exit.

Here are a few examples of CLI usage:

You will find more command line examples in the following sections.

Python SDK Usage

The following code sample routes the request port:7001 to the Netlas response search and prints search results to stdout.

import netlas

# you can access saved API key using this helper
apikey = netlas.helpers.get_api_key()

# create new connection to Netlas
netlas_connection = netlas.Netlas(api_key=apikey)

# retrieve data from responses by query `port:7001`
netlas_query = netlas_connection.query(query="port:7001")

# iterate over data and print: IP address, port, path and protocol
for response in netlas_query['items']:
    print(f"{response['data']['ip']}:{response['data']['port']}{response['data']['path']} [{response['data']['protocol']}]")
pass

Please keep in mind that the example is simplified. When developing automation, it is necessary at least to provide procedures for exception handling. And it is also necessary to take into account that the API key may not be saved.

You will find more Python examples in the following sections.