# Spyse Documentation

## API Reference
- [Quick start](https://spyse-dev.readme.io/reference/quick-start.md)
- [Details](https://spyse-dev.readme.io/reference/downloads_details.md): Get details about file download by its id.
- [List](https://spyse-dev.readme.io/reference/downloads_list.md): Returns details about all file downloads performed during the last 90 days. By default, GET operations, which return a list of requested items, return only the first 25 items. To get a different set of items, you can use the offset and limit parameters in the query string of the GET request.
- [Quotas](https://spyse-dev.readme.io/reference/account.md): Returns details about your account quotas.
- [The autonomous system object](https://spyse-dev.readme.io/reference/autonomous-system-model.md)
- [Details](https://spyse-dev.readme.io/reference/as_details.md): Returns details about the autonomous system (AS) by its number.
- [Search](https://spyse-dev.readme.io/reference/as_search.md): Returns a list of autonomous systems that matched the search query. Allows getting only the first 10,000 results. To get more results please use scroll or download API endpoints. By default, search operations, which return a list of found items, return only the first 25 items. To get a different set of items, you can use the offset and limit parameters in the request body.
- [Search count](https://spyse-dev.readme.io/reference/as_search_count.md): Returns the precise number of search results that matched the search query.
- [Search download](https://spyse-dev.readme.io/reference/as_search_download.md): Initiates the creation of the file with data about autonomous systems that matched the search query. When the file is created, it will be available for download. On the successful call, returns the unique identifier that represents the file creation process. The file creation is an asynchronous process because the amount of data that should be exported to the file and the export duration is hard to predict. The call to this endpoint just initiates the file creation. To check the file status and get the download link, send a GET request to the `/v4/data/account/downloads/` API endpoint with the identifier returned by this endpoint. The number of rows available for download is determined by the subscription plan.
- [Scroll search](https://spyse-dev.readme.io/reference/as_scroll_search.md): While a 'search' request allows to paginate over the first 10'000 results, the 'scroll search' can be used for deep pagination over a larger number of results (or even all results) in much the same way as you would use a cursor on a traditional database. In order to use scrolling, the initial search response will return a 'search_id' data field which should be specified in the subsequent requests in order to iterate over the rest of results.
- [Domains bulk search](https://spyse-dev.readme.io/reference/bulk_search_domain.md): Returns data about domains by domain name list. A maximum of 100 results can be obtained.
- [Domains bulk search download](https://spyse-dev.readme.io/reference/bulk_search_domain_download.md): Initiates the creation of the file with data about domains that matched the search query. When the file is created, it will be available for download. On the successful call, returns the unique identifier that represents the file creation process. The file creation is an asynchronous process, because the amount of data that should be exported to the file and the export duration is hard to predict. The call to this endpoint just initiates the file creation. To check the file status and get the download link, send a GET request to the `/v4/data/account/downloads/` API endpoint with the identifier returned by this endpoint. The number of rows available for download is determined by the subscription plan.
- [IP bulk search](https://spyse-dev.readme.io/reference/bulk_search_ip.md): Returns data about IPv4 hosts by IPv4 addresses list. A maximum of 100 results can be obtained.
- [IP bulk search download](https://spyse-dev.readme.io/reference/bulk_search_ip_download.md): Initiates the creation of the file with data about IPs that matched the search query. When the file is created, it will be available for download. On the successful call, returns the unique identifier that represents the file creation process. The file creation is an asynchronous process, because the amount of data that should be exported to the file and the export duration is hard to predict. The call to this endpoint just initiates the file creation. To check the file status and get the download link, send a GET request to the `/v4/data/account/downloads/` API endpoint with the identifier returned by this endpoint. The number of rows available for download is determined by the subscription plan.
- [The SSL/TLS certificate object](https://spyse-dev.readme.io/reference/the-ssltls-certificate-object.md)
- [Details](https://spyse-dev.readme.io/reference/certificate_details.md): Returns the current data about the given certificate.
- [Search](https://spyse-dev.readme.io/reference/certificate_search.md): Returns a list of certificates that matched the search query. Allows getting only the first 10,000 results. To get all results please use scroll or download API endpoints. By default, search operations, which return a list of found items, return only the first 25 items. To get a different set of items, you can use the offset and limit parameters in the request body.
- [Search count](https://spyse-dev.readme.io/reference/certificate_search_count.md): Returns the precise number of search results that matched the search query.
- [Search download](https://spyse-dev.readme.io/reference/certificate_search_download.md): Initiates the creation of the file with data about SSL certificates that matched the search query. When the file is created, it will be available for download. On the successful call, returns the unique identifier that represents the file creation process. The file creation is an asynchronous process, because the amount of data that should be exported to the file and the export duration is hard to predict. The call to this endpoint just initiates the file creation. To check the file status and get the download link, send a GET request to the `/v4/data/account/downloads/` API endpoint with the identifier returned by this endpoint. The number of rows available for download is determined by the subscription plan.
- [Scroll search](https://spyse-dev.readme.io/reference/certificate_scroll_search.md): While a 'search' request allows to paginate over the first 10'000 results, the 'scroll search' can be used for deep pagination over a larger number of results (or even all results) in much the same way as you would use a cursor on a traditional database. In order to use scrolling, the initial search response will return a 'search_id' data field which should be specified in the subsequent requests in order to iterate over the rest of results.
- [The CVE object](https://spyse-dev.readme.io/reference/the-cve-object.md)
- [Details](https://spyse-dev.readme.io/reference/cve_details.md): Returns details about the MITRE CVE by its identifier.
- [Search](https://spyse-dev.readme.io/reference/cve_search.md): Returns a list of CVEs that matched the search query. Allows getting only the first 10,000 results. To get more results please use scroll or download API endpoints. By default, search operations, which return a list of found items, return only the first 25 items. To get a different set of items, you can use the offset and limit parameters in the request body.
- [Search count](https://spyse-dev.readme.io/reference/cve_search_count.md): Returns the precise number of search results that matched the search query.
- [Search download](https://spyse-dev.readme.io/reference/cve_search_download.md): Initiates the creation of the file with data about CVEs that matched the search query. When the file is created, it will be available for download. On the successful call, returns the unique identifier that represents the file creation process. The file creation is an asynchronous process because the amount of data that should be exported to the file and the export duration is hard to predict. The call to this endpoint just initiates the file creation. To check the file status and get the download link, send a GET request to the `/v4/data/account/downloads/` API endpoint with the identifier returned by this endpoint. The number of rows available for download is determined by the subscription plan.
- [Scroll search](https://spyse-dev.readme.io/reference/cve_scroll_search.md): While a 'search' request allows to paginate over the first 10'000 results, the 'scroll search' can be used for deep pagination over a larger number of results (or even all results) in much the same way as you would use a cursor on a traditional database. In order to use scrolling, the initial search response will return a 'search_id' data field which should be specified in the subsequent requests in order to iterate over the rest of results.
- [The domain object](https://spyse-dev.readme.io/reference/the-domain-object.md)
- [Details](https://spyse-dev.readme.io/reference/domain_details.md): Returns details about domain by its name.
- [Search](https://spyse-dev.readme.io/reference/domain_search.md): Returns a list of domains that matched the search query. Allows getting only the first 10,000 results. To get more results please use scroll or download API endpoints. By default, search operations, which return a list of found items, return only the first 25 items. To get a different set of items, you can use the offset and limit parameters in the request body.
- [Search count](https://spyse-dev.readme.io/reference/domain_search_count.md): Returns the precise number of search results that matched the search query.
- [Search download](https://spyse-dev.readme.io/reference/domain_search_download.md): Initiates the creation of the file with data about domains that matched the search query. When the file is created, it will be available for download. On the successful call, returns the unique identifier that represents the file creation process. The file creation is an asynchronous process, because the amount of data that should be exported to the file and the export duration is hard to predict. The call to this endpoint just initiates the file creation. To check the file status and get the download link, send a GET request to the `/v4/data/account/downloads/` API endpoint with the identifier returned by this endpoint. The number of rows available for download is determined by the subscription plan.
- [Scroll search](https://spyse-dev.readme.io/reference/domain_scroll_search.md): While a 'search' request allows to paginate over the first 10'000 results, the 'scroll search' can be used for deep pagination over a larger number of results (or even all results) in much the same way as you would use a cursor on a traditional database. In order to use scrolling, the initial search response will return a 'search_id' data field which should be specified in the subsequent requests in order to iterate over the rest of results.
- [On demand scan](https://spyse-dev.readme.io/reference/bulk_domain_scan.md): Use this method to request a domains crawl. You can scan up to 100 domains at a time. Scanning usually takes about 1 minute. Scan results can be obtained using the endpoints /domain, /domain/search or /bulk-search/domain.
- [The email object](https://spyse-dev.readme.io/reference/the-email-object.md)
- [Details](https://spyse-dev.readme.io/reference/email_details.md): Returns details about email address.
- [Search](https://spyse-dev.readme.io/reference/email_search.md): Returns a list of emails that matched the search query. Allows getting only the first 10,000 results. To get all results please use scroll or download API endpoints. By default, search operations, which return a list of found items, return only the first 25 items. To get a different set of items, you can use the offset and limit parameters in the request body.
- [Search count](https://spyse-dev.readme.io/reference/email_search_count.md): Returns the precise number of search results that matched the search query.
- [Search download](https://spyse-dev.readme.io/reference/email_search_download.md): Initiates the creation of the file with data about emails that matched the search query. When the file is created, it will be available for download. On the successful call, returns the unique identifier that represents the file creation process. The file creation is an asynchronous process because the amount of data that should be exported to the file and the export duration is hard to predict. The call to this endpoint just initiates the file creation. To check the file status and get the download link, send a GET request to the `/v4/data/account/downloads/` API endpoint with the identifier returned by this endpoint. The number of rows available for download is determined by the subscription plan.
- [Scroll search](https://spyse-dev.readme.io/reference/email_scroll_search.md): While a 'search' request allows to paginate over the first 10'000 results, the 'scroll search' can be used for deep pagination over a larger number of results (or even all results) in much the same way as you would use a cursor on a traditional database. In order to use scrolling, the initial search response will return a 'search_id' data field which should be specified in the subsequent requests in order to iterate over the rest of results.
- [DNS history](https://spyse-dev.readme.io/reference/dns_history.md): Returns the historical DNS records about the given domain name.
- [DNS history count](https://spyse-dev.readme.io/reference/dns_history_count.md): Returns the number of historical DNS records about the given domain name.
- [WHOIS history](https://spyse-dev.readme.io/reference/domain_whois_history.md): Returns the historical WHOIS records for the given domain name.
- [The IP object](https://spyse-dev.readme.io/reference/the-ip-object.md)
- [Details](https://spyse-dev.readme.io/reference/ip_details.md): Returns the current data about the given IP address.
- [Search](https://spyse-dev.readme.io/reference/ip_search.md): Returns a list of IP hosts that matched the search query. Allows getting only the first 10,000 results. To get all results please use scroll or download API endpoints. By default, search operations, which return a list of found items, return only the first 25 items. To get a different set of items, you can use the offset and limit parameters in the request body.
- [Search count](https://spyse-dev.readme.io/reference/ip_search_count.md): Returns the precise number of search results that matched the search query.
- [Search download](https://spyse-dev.readme.io/reference/ip_search_download.md): Initiates the creation of the file with data about IPs that matched the search query. When the file is created, it will be available for download. On the successful call, returns the unique identifier that represents the file creation process. The file creation is an asynchronous process, because the amount of data that should be exported to the file and the export duration is hard to predict. The call to this endpoint just initiates the file creation. To check the file status and get the download link, send a GET request to the `/v4/data/account/downloads/` API endpoint with the identifier returned by this endpoint. The number of rows available for download is determined by the subscription plan.
- [Scroll search](https://spyse-dev.readme.io/reference/ip_scroll_search.md): While a 'search' request allows to paginate over the first 10'000 results, the 'scroll search' can be used for deep pagination over a larger number of results (or even all results) in much the same way as you would use a cursor on a traditional database. In order to use scrolling, the initial search response will return a 'search_id' data field which should be specified in the subsequent requests in order to iterate over the rest of results.