# censys-sdk-typescript Developer-friendly & type-safe Typescript SDK specifically catered to leverage the Censys Platform API.
## Summary ## Table of Contents * [censys-sdk-typescript](#censys-sdk-typescript) * [SDK Installation](#sdk-installation) * [Requirements](#requirements) * [SDK Example Usage](#sdk-example-usage) * [Available Resources and Operations](#available-resources-and-operations) * [Standalone functions](#standalone-functions) * [Global Parameters](#global-parameters) * [Retries](#retries) * [Error Handling](#error-handling) * [Server Selection](#server-selection) * [Custom HTTP Client](#custom-http-client) * [Authentication](#authentication) * [Debugging](#debugging) * [Development](#development) * [Maturity](#maturity) * [Contributions](#contributions) ## SDK Installation The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers. ### NPM ```bash npm add @censys/platform-sdk ``` ### PNPM ```bash pnpm add @censys/platform-sdk ``` ### Bun ```bash bun add @censys/platform-sdk ``` ### Yarn ```bash yarn add @censys/platform-sdk ``` ## Requirements For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md). ## SDK Example Usage ### Example ```typescript import { SDK } from "@censys/platform-sdk"; const sdk = new SDK({ organizationId: "11111111-2222-3333-4444-555555555555", personalAccessToken: "", }); async function run() { const result = await sdk.globalData.search({ searchQueryInputBody: { fields: [ "host.ip", ], pageSize: 1, query: "host.services: (protocol=SSH and not port: 22)", }, }); console.log(result); } run(); ``` ## Available Resources and Operations
Available methods ### [AccountManagement](docs/sdks/accountmanagement/README.md) * [getOrganizationDetails](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization details * [getOrganizationCredits](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit balance * [getOrganizationCreditUsage](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage * [inviteUserToOrganization](docs/sdks/accountmanagement/README.md#inviteusertoorganization) - Invite user to organization * [listOrganizationMembers](docs/sdks/accountmanagement/README.md#listorganizationmembers) - List organization members * [removeOrganizationMember](docs/sdks/accountmanagement/README.md#removeorganizationmember) - Remove member from organization * [updateOrganizationMember](docs/sdks/accountmanagement/README.md#updateorganizationmember) - Update a member's roles in an organization * [getMemberCreditUsage](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get organization member credit usage * [getUserCredits](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit balance * [getUserCreditsUsage](docs/sdks/accountmanagement/README.md#getusercreditsusage) - Get Free user credit usage ### [AdversaryInvestigation](docs/sdks/adversaryinvestigation/README.md) * [createCenseyeJob](docs/sdks/adversaryinvestigation/README.md#createcenseyejob) - CensEye: Create a pivot analysis job * [getCenseyeJob](docs/sdks/adversaryinvestigation/README.md#getcenseyejob) - CensEye: Get job status * [getCenseyeJobResults](docs/sdks/adversaryinvestigation/README.md#getcenseyejobresults) - CensEye: Get job results * [getHostObservationsWithCertificate](docs/sdks/adversaryinvestigation/README.md#gethostobservationswithcertificate) - Get host history for a certificate * [createTrackedScan](docs/sdks/adversaryinvestigation/README.md#createtrackedscan) - Live Discovery: Initiate a new scan * [listThreats](docs/sdks/adversaryinvestigation/README.md#listthreats) - List active threats * [valueCounts](docs/sdks/adversaryinvestigation/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots ### [Collections](docs/sdks/collections/README.md) * [list](docs/sdks/collections/README.md#list) - List collections * [create](docs/sdks/collections/README.md#create) - Create a collection * [delete](docs/sdks/collections/README.md#delete) - Delete a collection * [get](docs/sdks/collections/README.md#get) - Get a collection * [update](docs/sdks/collections/README.md#update) - Update a collection * [listEvents](docs/sdks/collections/README.md#listevents) - Get a collection's events * [aggregate](docs/sdks/collections/README.md#aggregate) - Aggregate results for a search query within a collection * [search](docs/sdks/collections/README.md#search) - Run a search query within a collection ### [GlobalData](docs/sdks/globaldata/README.md) * [getCertificates](docs/sdks/globaldata/README.md#getcertificates) - Retrieve multiple certificates * [getCertificatesRaw](docs/sdks/globaldata/README.md#getcertificatesraw) - Retrieve multiple certificates in PEM format * [getCertificate](docs/sdks/globaldata/README.md#getcertificate) - Get a certificate * [getCertificateRaw](docs/sdks/globaldata/README.md#getcertificateraw) - Get a certificate in PEM format * [getHosts](docs/sdks/globaldata/README.md#gethosts) - Retrieve multiple hosts * [getHost](docs/sdks/globaldata/README.md#gethost) - Get a host * [listServicesOnHost](docs/sdks/globaldata/README.md#listservicesonhost) - Get service history for a host * [getHostTimeline](docs/sdks/globaldata/README.md#gethosttimeline) - Get host event history * [getWebProperties](docs/sdks/globaldata/README.md#getwebproperties) - Retrieve multiple web properties * [getWebProperty](docs/sdks/globaldata/README.md#getwebproperty) - Get a web property * [createTrackedScan](docs/sdks/globaldata/README.md#createtrackedscan) - Live Rescan: Initiate a new rescan * [getTrackedScan](docs/sdks/globaldata/README.md#gettrackedscan) - Get scan status * [aggregate](docs/sdks/globaldata/README.md#aggregate) - Aggregate results for a search query * [convertLegacySearchQueries](docs/sdks/globaldata/README.md#convertlegacysearchqueries) - Convert Legacy Search queries to Platform queries * [search](docs/sdks/globaldata/README.md#search) - Run a search query ### [ThreatHunting](docs/sdks/threathunting/README.md) * [listCenseyeJobs](docs/sdks/threathunting/README.md#listcenseyejobs) - CensEye: List jobs * [createCenseyeJob](docs/sdks/threathunting/README.md#createcenseyejob) - CensEye: Create a pivot analysis job * [getCenseyeJob](docs/sdks/threathunting/README.md#getcenseyejob) - CensEye: Get job status * [getCenseyeJobResults](docs/sdks/threathunting/README.md#getcenseyejobresults) - CensEye: Get job results * [getHostObservationsWithCertificate](docs/sdks/threathunting/README.md#gethostobservationswithcertificate) - Get host history for a certificate * [createTrackedScan](docs/sdks/threathunting/README.md#createtrackedscan) - Live Discovery: Initiate a new scan * [getTrackedScanThreatHunting](docs/sdks/threathunting/README.md#gettrackedscanthreathunting) - Get scan status * [listThreats](docs/sdks/threathunting/README.md#listthreats) - List active threats * [valueCounts](docs/sdks/threathunting/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots
## Standalone functions All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away. To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
Available standalone functions - [`accountManagementGetMemberCreditUsage`](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get organization member credit usage - [`accountManagementGetOrganizationCredits`](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit balance - [`accountManagementGetOrganizationCreditUsage`](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage - [`accountManagementGetOrganizationDetails`](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization details - [`accountManagementGetUserCredits`](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit balance - [`accountManagementGetUserCreditsUsage`](docs/sdks/accountmanagement/README.md#getusercreditsusage) - Get Free user credit usage - [`accountManagementInviteUserToOrganization`](docs/sdks/accountmanagement/README.md#inviteusertoorganization) - Invite user to organization - [`accountManagementListOrganizationMembers`](docs/sdks/accountmanagement/README.md#listorganizationmembers) - List organization members - [`accountManagementRemoveOrganizationMember`](docs/sdks/accountmanagement/README.md#removeorganizationmember) - Remove member from organization - [`accountManagementUpdateOrganizationMember`](docs/sdks/accountmanagement/README.md#updateorganizationmember) - Update a member's roles in an organization - [`collectionsAggregate`](docs/sdks/collections/README.md#aggregate) - Aggregate results for a search query within a collection - [`collectionsCreate`](docs/sdks/collections/README.md#create) - Create a collection - [`collectionsDelete`](docs/sdks/collections/README.md#delete) - Delete a collection - [`collectionsGet`](docs/sdks/collections/README.md#get) - Get a collection - [`collectionsList`](docs/sdks/collections/README.md#list) - List collections - [`collectionsListEvents`](docs/sdks/collections/README.md#listevents) - Get a collection's events - [`collectionsSearch`](docs/sdks/collections/README.md#search) - Run a search query within a collection - [`collectionsUpdate`](docs/sdks/collections/README.md#update) - Update a collection - [`globalDataAggregate`](docs/sdks/globaldata/README.md#aggregate) - Aggregate results for a search query - [`globalDataConvertLegacySearchQueries`](docs/sdks/globaldata/README.md#convertlegacysearchqueries) - Convert Legacy Search queries to Platform queries - [`globalDataCreateTrackedScan`](docs/sdks/globaldata/README.md#createtrackedscan) - Live Rescan: Initiate a new rescan - [`globalDataGetCertificate`](docs/sdks/globaldata/README.md#getcertificate) - Get a certificate - [`globalDataGetCertificateRaw`](docs/sdks/globaldata/README.md#getcertificateraw) - Get a certificate in PEM format - [`globalDataGetCertificates`](docs/sdks/globaldata/README.md#getcertificates) - Retrieve multiple certificates - [`globalDataGetCertificatesRaw`](docs/sdks/globaldata/README.md#getcertificatesraw) - Retrieve multiple certificates in PEM format - [`globalDataGetHost`](docs/sdks/globaldata/README.md#gethost) - Get a host - [`globalDataGetHosts`](docs/sdks/globaldata/README.md#gethosts) - Retrieve multiple hosts - [`globalDataGetHostTimeline`](docs/sdks/globaldata/README.md#gethosttimeline) - Get host event history - [`globalDataGetTrackedScan`](docs/sdks/globaldata/README.md#gettrackedscan) - Get scan status - [`globalDataGetWebProperties`](docs/sdks/globaldata/README.md#getwebproperties) - Retrieve multiple web properties - [`globalDataGetWebProperty`](docs/sdks/globaldata/README.md#getwebproperty) - Get a web property - [`globalDataListServicesOnHost`](docs/sdks/globaldata/README.md#listservicesonhost) - Get service history for a host - [`globalDataSearch`](docs/sdks/globaldata/README.md#search) - Run a search query - [`threatHuntingCreateCenseyeJob`](docs/sdks/adversaryinvestigation/README.md#createcenseyejob) - CensEye: Create a pivot analysis job - [`threatHuntingCreateCenseyeJob`](docs/sdks/threathunting/README.md#createcenseyejob) - CensEye: Create a pivot analysis job - [`threatHuntingCreateTrackedScan`](docs/sdks/adversaryinvestigation/README.md#createtrackedscan) - Live Discovery: Initiate a new scan - [`threatHuntingCreateTrackedScan`](docs/sdks/threathunting/README.md#createtrackedscan) - Live Discovery: Initiate a new scan - [`threatHuntingGetCenseyeJob`](docs/sdks/adversaryinvestigation/README.md#getcenseyejob) - CensEye: Get job status - [`threatHuntingGetCenseyeJob`](docs/sdks/threathunting/README.md#getcenseyejob) - CensEye: Get job status - [`threatHuntingGetCenseyeJobResults`](docs/sdks/adversaryinvestigation/README.md#getcenseyejobresults) - CensEye: Get job results - [`threatHuntingGetCenseyeJobResults`](docs/sdks/threathunting/README.md#getcenseyejobresults) - CensEye: Get job results - [`threatHuntingGetHostObservationsWithCertificate`](docs/sdks/adversaryinvestigation/README.md#gethostobservationswithcertificate) - Get host history for a certificate - [`threatHuntingGetHostObservationsWithCertificate`](docs/sdks/threathunting/README.md#gethostobservationswithcertificate) - Get host history for a certificate - [`threatHuntingGetTrackedScanThreatHunting`](docs/sdks/threathunting/README.md#gettrackedscanthreathunting) - Get scan status - [`threatHuntingListCenseyeJobs`](docs/sdks/threathunting/README.md#listcenseyejobs) - CensEye: List jobs - [`threatHuntingListThreats`](docs/sdks/adversaryinvestigation/README.md#listthreats) - List active threats - [`threatHuntingListThreats`](docs/sdks/threathunting/README.md#listthreats) - List active threats - [`threatHuntingValueCounts`](docs/sdks/adversaryinvestigation/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots - [`threatHuntingValueCounts`](docs/sdks/threathunting/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots
## Global Parameters A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed. For example, you can set `organization_id` to `` at SDK initialization and then you do not have to pass the same value on calls to operations like `getOrganizationDetails`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. ### Available Globals The following global parameter is available. | Name | Type | Description | | -------------- | ------ | ----------------------------- | | organizationId | string | The organizationId parameter. | ### Example ```typescript import { SDK } from "@censys/platform-sdk"; const sdk = new SDK({ organizationId: "11111111-2222-3333-4444-555555555555", personalAccessToken: "", }); async function run() { const result = await sdk.accountManagement.getOrganizationDetails({ organizationId: "11111111-2222-3333-4444-555555555555", }); console.log(result); } run(); ``` ## Retries Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. To change the default retry strategy for a single API call, simply provide a retryConfig object to the call: ```typescript import { SDK } from "@censys/platform-sdk"; const sdk = new SDK({ personalAccessToken: "", }); async function run() { const result = await sdk.accountManagement.getOrganizationDetails({ organizationId: "11111111-2222-3333-4444-555555555555", }, { retries: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, }); console.log(result); } run(); ``` If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization: ```typescript import { SDK } from "@censys/platform-sdk"; const sdk = new SDK({ retryConfig: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, personalAccessToken: "", }); async function run() { const result = await sdk.accountManagement.getOrganizationDetails({ organizationId: "11111111-2222-3333-4444-555555555555", }); console.log(result); } run(); ``` ## Error Handling [`SDKBaseError`](./src/models/errors/sdkbaseerror.ts) is the base class for all HTTP error responses. It has the following properties: | Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | `error.message` | `string` | Error message | | `error.statusCode` | `number` | HTTP response status code eg `404` | | `error.headers` | `Headers` | HTTP response headers | | `error.body` | `string` | HTTP body. Can be empty string if no body is returned. | | `error.rawResponse` | `Response` | Raw HTTP response | | `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). | ### Example ```typescript import { SDK } from "@censys/platform-sdk"; import * as errors from "@censys/platform-sdk/models/errors"; const sdk = new SDK({ personalAccessToken: "", }); async function run() { try { const result = await sdk.accountManagement.getOrganizationDetails({ organizationId: "11111111-2222-3333-4444-555555555555", }); console.log(result); } catch (error) { // The base class for HTTP error responses if (error instanceof errors.SDKBaseError) { console.log(error.message); console.log(error.statusCode); console.log(error.body); console.log(error.headers); // Depending on the method different errors may be thrown if (error instanceof errors.AuthenticationError) { console.log(error.data$.error); // components.AuthenticationErrorDetail } } } } run(); ``` ### Error Classes **Primary errors:** * [`SDKBaseError`](./src/models/errors/sdkbaseerror.ts): The base class for HTTP error responses. * [`ErrorModel`](./src/models/errors/errormodel.ts): * * [`AuthenticationError`](./src/models/errors/authenticationerror.ts): Request does not contain a valid Authorization token. Status code `401`. *
Less common errors (6)
**Network errors:** * [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server. * [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal. * [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client. * [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid. * [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error. **Inherit from [`SDKBaseError`](./src/models/errors/sdkbaseerror.ts)**: * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable. ## Server Selection ### Override Server URL Per-Client The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example: ```typescript import { SDK } from "@censys/platform-sdk"; const sdk = new SDK({ serverURL: "https://api.platform.censys.io", personalAccessToken: "", }); async function run() { const result = await sdk.accountManagement.getOrganizationDetails({ organizationId: "11111111-2222-3333-4444-555555555555", }); console.log(result); } run(); ``` ## Custom HTTP Client The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This client is a thin wrapper around `fetch` and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response. The `HTTPClient` constructor takes an optional `fetcher` argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures. The following example shows how to: - route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent - use the `"beforeRequest"` hook to add a custom header and a timeout to requests - use the `"requestError"` hook to log errors ```typescript import { SDK } from "@censys/platform-sdk"; import { ProxyAgent } from "undici"; import { HTTPClient } from "@censys/platform-sdk/lib/http"; const dispatcher = new ProxyAgent("http://proxy.example.com:8080"); const httpClient = new HTTPClient({ // 'fetcher' takes a function that has the same signature as native 'fetch'. fetcher: (input, init) => // 'dispatcher' is specific to undici and not part of the standard Fetch API. fetch(input, { ...init, dispatcher } as RequestInit), }); httpClient.addHook("beforeRequest", (request) => { const nextRequest = new Request(request, { signal: request.signal || AbortSignal.timeout(5000) }); nextRequest.headers.set("x-custom-header", "custom value"); return nextRequest; }); httpClient.addHook("requestError", (error, request) => { console.group("Request Error"); console.log("Reason:", `${error}`); console.log("Endpoint:", `${request.method} ${request.url}`); console.groupEnd(); }); const sdk = new SDK({ httpClient: httpClient }); ``` ## Authentication ### Per-Client Security Schemes This SDK supports the following security scheme globally: | Name | Type | Scheme | | --------------------- | ---- | ----------- | | `personalAccessToken` | http | HTTP Bearer | To authenticate with the API the `personalAccessToken` parameter must be set when initializing the SDK client instance. For example: ```typescript import { SDK } from "@censys/platform-sdk"; const sdk = new SDK({ personalAccessToken: "", }); async function run() { const result = await sdk.accountManagement.getOrganizationDetails({ organizationId: "11111111-2222-3333-4444-555555555555", }); console.log(result); } run(); ``` ## Debugging You can setup your SDK to emit debug logs for SDK requests and responses. You can pass a logger that matches `console`'s interface as an SDK option. > [!WARNING] > Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production. ```typescript import { SDK } from "@censys/platform-sdk"; const sdk = new SDK({ debugLogger: console }); ``` # Development ## Maturity This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version. ## Contributions While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. ### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=openapi&utm_campaign=typescript)