API Endpoints

Attention

API documentation is under development

Note

All requests to endpoints below should include X-API-Key header with your api key which can be found in profile page

Responses

Count

Count documents by given query

Example: api/responses_count/?q=<QUERY>&indices=<INDEX_ID>

Method

Request

Description

GET

  • q

  • indices (optional)

  • str Search query

  • int Comma separated list of indices ids (default - latest)

Statistics

Get statistics by given query

Example: api/responses_stat/?q=<QUERY>&indices=<INDEX_ID>

Method

Request

Description

GET

  • q

  • indices (optional)

  • str Search query

  • int Comma separated list of indices ids (default - latest)

Download

Download documents using file stream

Example: api/filestream/d54e6ad8cccf419bd6416180349e9132/869455736a241b3c69cfa3ab741c78c6/

Domains

Search

Get documents by given query

Example: api/domains/?q=<QUERY>

Method

Request

Description

GET

  • q

  • indices (optional)

  • start (optional)

  • fields

  • source_type

  • str Search query

  • int Comma separated list of indices ids (default - latest)

  • int offset (default 0)

  • list Comma-separated list of fields to include/exclude

  • str Include or exclude fields (choices: include, exclude)

Count

Count documents by given query

Example: api/domains_count/?q=<QUERY>

Method

Request

Description

GET

  • q

  • indices (optional)

  • str Search query

  • int Comma separated list of indices ids (default - latest)

Statistics

Get statistics by given query

Example: api/domains_stat/?q=<QUERY>&indices=<INDEX_ID>

Method

Request

Description

GET

  • q

  • indices (optional)

  • str Search query

  • int Comma separated list of indices ids (default - latest)

Get download link

Get link for downloading documents by given query

Example: api/domains/download/?q=<QUERY>

Method

Request

Description

POST

  • q

  • fields

  • size

  • source_type

  • indices (optional)

  • type (optional)

  • raw (optional)

  • str Search query

  • list Comma-separated list of fields to include/exclude

  • int Number of documents to download

  • str Include or exclude fields (choices: include, exclude)

  • list Comma-separated IDs of selected data indices (can be retrieved by indices method) (default - latest)

  • str File format (choices: json, csv) (default “json”)

  • bool (default False)

Download

Download documents using file stream

Example: api/filestream/d54e6ad8cccf419bd6416180349e9132/869455736a241b3c69cfa3ab741c78c6/

Certificates

Search

Get documents by given query

Example: api/certs/?q=<QUERY>

Method

Request

Description

GET

  • q

  • indices (optional)

  • start (optional)

  • fields

  • source_type

  • str Search query

  • int Comma separated list of indices ids (default - latest)

  • int offset (default 0)

  • list Comma-separated list of fields to include/exclude

  • str Include or exclude fields (choices: include, exclude)

Count

Count documents by given query

Example: api/certs_count/?q=<QUERY>

Method

Request

Description

GET

  • q

  • indices (optional)

  • str Search query

  • int Comma separated list of indices ids (default - latest)

Get download link

Get link for downloading documents by given query

Example: api/certs/download/?q=<QUERY>

Method

Request

Description

POST

  • q

  • fields

  • size

  • source_type

  • indices (optional)

  • type (optional)

  • raw (optional)

  • str Search query

  • list Comma-separated list of fields to include/exclude

  • int Number of documents to download

  • str Include or exclude fields (choices: include, exclude)

  • list Comma-separated IDs of selected data indices (can be retrieved by indices method) (default - latest)

  • str File format (choices: json, csv) (default “json”)

  • bool (default False)

Download

Download documents using file stream

Example: api/filestream/d54e6ad8cccf419bd6416180349e9132/869455736a241b3c69cfa3ab741c78c6/

WHOIS IP

Search

Get documents by given query

Example: api/whois_ip/?q=<QUERY>

Method

Request

Description

GET

  • q

  • indices (optional)

  • start (optional)

  • fields

  • source_type

  • str Search query

  • int Comma separated list of indices ids (default - latest)

  • int offset (default 0)

  • list Comma-separated list of fields to include/exclude

  • str Include or exclude fields (choices: include, exclude)

Count

Count documents by given query

Example: api/whois_ip_count/?q=<QUERY>

Method

Request

Description

GET

  • q

  • indices (optional)

  • str Search query

  • int Comma separated list of indices ids (default - latest)

Get download link

Get link for downloading documents by given query

Example: api/whois_ip/download/?q=<QUERY>

Method

Request

Description

POST

  • q

  • fields

  • size

  • source_type

  • indices (optional)

  • type (optional)

  • raw (optional)

  • str Search query

  • list Comma-separated list of fields to include/exclude

  • int Number of documents to download

  • str Include or exclude fields (choices: include, exclude)

  • list Comma-separated IDs of selected data indices (can be retrieved by indices method) (default - latest)

  • str File format (choices: json, csv) (default “json”)

  • bool (default False)

Download

Download documents using file stream

Example: api/filestream/d54e6ad8cccf419bd6416180349e9132/869455736a241b3c69cfa3ab741c78c6/

WHOIS DOMAINS

Search

Get documents by given query

Example: api/whois_domains/?q=<QUERY>

Method

Request

Description

GET

  • q

  • indices (optional)

  • start (optional)

  • fields

  • source_type

  • str Search query

  • int Comma separated list of indices ids (default - latest)

  • int offset (default 0)

  • list Comma-separated list of fields to include/exclude

  • str Include or exclude fields (choices: include, exclude)

Count

Count documents by given query

Example: api/whois_domains_count/?q=<QUERY>

Method

Request

Description

GET

  • q

  • indices (optional)

  • str Search query

  • int Comma separated list of indices ids (default - latest)

Get download link

Get link for downloading documents by given query

Example: api/whois_domains/download/?q=<QUERY>

Method

Request

Description

POST

  • q

  • fields

  • size

  • source_type

  • indices (optional)

  • type (optional)

  • raw (optional)

  • str Search query

  • list Comma-separated list of fields to include/exclude

  • int Number of documents to download

  • str Include or exclude fields (choices: include, exclude)

  • list Comma-separated IDs of selected data indices (can be retrieved by indices method) (default - latest)

  • str File format (choices: json, csv) (default “json”)

  • bool (default False)

Download

Download documents using file stream

Example: api/filestream/d54e6ad8cccf419bd6416180349e9132/869455736a241b3c69cfa3ab741c78c6/

HOST

Search

Get documents by given query. Both ip address and domain might be used as a search query

Examples: api/host/8.8.8.8/ api/host/netlas.io/

Method

Request

Description

GET

  • fields

  • source_type

  • list Comma-separated list of fields to include/exclude

  • str Include or exclude fields (choices: include, exclude)

Exposed ports & software

Get documents by given query. Both ip address and domain might be used as a search query

Examples: api/domain_software/?q=(domain:*.netlas.io+AND+NOT+domain:netlas.io)&host=netlas.io

Method

Request

Description

GET

  • q

  • host

  • str Search query

  • str Target host

API Key

Reset API Key

Reset current api key and get new one

Example: api/api_keys/reset_api_key/

Indices

List

Get list of available indices

Example: api/indices/

User

Profile

Get data about current user

Example: api/users/current/