A simple client for interacting with the urlscan.io API. This library provides easy-to-use methods to scan URLs, retrieve scan results, and search for previously scanned URLs.
To install the @iocium/urlscan package, use npm:
npm install @iocium/urlscan
To get started, you need to initialize the UrlscanClient with your API key:
import { UrlscanClient } from '@iocium/urlscan';
const client = new UrlscanClient('YOUR_API_KEY');
You can scan a URL by calling the scan method. Optionally, you can provide additional options.
const response = await client.scan('https://example.com', {
// Optional parameters can be included here
});
console.log(response);
To retrieve the results of a scan, use the getScan method with the scan ID.
const result = await client.getScan('SCAN_ID');
console.log(result);
You can search for scans using specific terms. The search method allows you to pass optional search parameters.
const searchResults = await client.search('example query', {
// Optional search parameters can be included here
});
console.log(searchResults);
The UrlscanClient handles errors gracefully. If an error occurs during a fetch operation, it will log the error message to the console. Additionally, certain methods throw errors when required parameters are not provided. Ensure to handle these appropriately in your application.
Example of handling errors:
try {
const result = await client.scan('https://example.com');
} catch (error) {
console.error('An error occurred:', error.message);
}
npm test # Runs mocked tests
npm run test:live # Runs real network integration tests (LIVE_TEST=true). This needs an urlscan.io API key via URLSCAN_API
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
git checkout -b feature/YourFeature).git commit -m 'Add some feature').git push origin feature/YourFeature).This project is licensed under the MIT License. See the LICENSE file for details.
Made with 💙 by Iocium