https://github.com/crowdstrike/falconjs

CrowdStrike Falcon API JS library for the browser and Node
https://github.com/crowdstrike/falconjs

api browser javascript node typescript

Last synced: 4 months ago
JSON representation

CrowdStrike Falcon API JS library for the browser and Node

• Host: GitHub
• URL: https://github.com/crowdstrike/falconjs
• Owner: CrowdStrike
• License: mit
• Created: 2022-01-09T16:49:16.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2026-02-24T17:37:41.000Z (4 months ago)
• Last Synced: 2026-02-25T13:32:17.795Z (4 months ago)
• Topics: api, browser, javascript, node, typescript
• Language: TypeScript
• Homepage:
• Size: 4.85 MB
• Stars: 23
• Watchers: 3
• Forks: 13
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# FalconJS

[![Version](https://img.shields.io/npm/v/crowdstrike-falcon.svg)](https://www.npmjs.com/package/crowdstrike-falcon)

[![Build](https://github.com/CrowdStrike/falconjs/actions/workflows/sanity_check.yaml/badge.svg)](https://github.com/CrowdStrike/falconjs/actions/workflows/sanity_check.yaml)

[![License](https://img.shields.io/github/license/crowdstrike/falconjs.svg)](https://github.com/crowdstrike/falconjs/blob/main/LICENSE)

[![NPM](https://nodei.co/npm/crowdstrike-falcon.png?mini=true)](https://npmjs.org/package/crowdstrike-falcon)

TypeScript SDK for the CrowdStrike Falcon API.

## Experimental

> falconjs is an open source project, not a CrowdStrike product. It carries no formal support, expressed or implied.

## Installation

```bash

npm install crowdstrike-falcon

```

## Features

- **TypeScript-first** — fully typed request and response models

- **120+ API services** — detections, hosts, intel, spotlight, real-time response, and more

- **OAuth2 built-in** — automatic token management via middleware

## Quick Start

```typescript

import { FalconClient, FalconErrorExplain } from "crowdstrike-falcon";

const client = new FalconClient({

    cloud: "us-1",

    clientId: "your-client-id",

    clientSecret: "your-client-secret",

});

await client.sensorDownload

    .getSensorInstallersCCIDByQuery()

    .catch(async function (err) {

        console.error("Could not fetch CCID: " + (await FalconErrorExplain(err)));

    })

    .then((value) => {

        console.log("my CCID: ", value);

    });

```

## Documentation

- [Example usage under nodejs](examples/node/README.md)

- [Example usage inside browser](examples/browser/README.md)

- [SDK Developer documentation](docs/devel.md)

- [CrowdStrike API documentation](https://docs.crowdstrike.com/p/api)