npmpackage.info

Gathering detailed insights and metrics for @fingerprintjs/fingerprintjs-pro-server-api

@fingerprintjs/fingerprintjs-pro-server-api - 6.7.0 | npmpackage.info

@fingerprintjs/fingerprintjs-pro-server-api

Node.js wrapper for FingerprintJS Server API

6.7.0

MIT

TypeScript

291.34 kB

5.3

Installations

npm install @fingerprintjs/fingerprintjs-pro-server-api

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Min. Node Version

>=18.17.0

Node Version

21.7.3

NPM Version

10.5.0 Pull Requests

Open

1

Total

188

Closed

24

Merged

163

Issues

Open

4

Total

9

Closed

5

Releases

@fingerprintjs/fingerprintjs-pro-server-api@6.7.0

Updated on Jul 09, 2025

@fingerprintjs/fingerprintjs-pro-server-api@6.6.0

Updated on Jun 04, 2025

@fingerprintjs/fingerprintjs-pro-server-api@6.5.0

Updated on May 06, 2025

@fingerprintjs/fingerprintjs-pro-server-api@6.5.0-test.1

Updated on Apr 28, 2025

@fingerprintjs/fingerprintjs-pro-server-api@6.5.0-test.0

Updated on Apr 16, 2025

@fingerprintjs/fingerprintjs-pro-server-api@6.4.0

Updated on Apr 02, 2025

View All 47 releases

Languages

TypeScript

JavaScript

Shell

TypeScript (90.6%)

JavaScript (8.4%)

Shell (0.99%)

Developer

fingerprintjs

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

24 Stars

665 Commits

8 Forks

8 Watchers

6 Branches

12 Contributors

Updated on Jul 10, 2025

Maintainers

View All 12 Contributors

Package Meta Information

Latest Version

6.7.0

Package Id

@fingerprintjs/fingerprintjs-pro-server-api@6.7.0

Unpacked Size

291.34 kB

Size

50.99 kB

File Count

NPM Version

10.5.0

Node Version

21.7.3

Published on

Jul 09, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Fingerprint Server API Node.js SDK

Fingerprint is a device intelligence platform offering industry-leading accuracy.

The Fingerprint Server Node SDK is an easy way to interact with the Fingerprint Server API from your Node application. You can search, update, or delete identification events.

Requirements

TypeScript support:

TypeScript 4.5.5 or higher

Supported runtimes:

Node.js 18 LTS or higher (we support all Node LTS releases before end-of-life).
Deno and Bun might work but are not actively tested.
"Edge" runtimes might work with some modifications but are not actively tested.
See "edge" runtimes compatibility

This SDK can be made compatible with JavaScript "edge" runtimes that do not support all Node APIs, for example, Vercel Edge Runtime, or Cloudflare Workers.

To make it work, replace the SDK's built-in fetch function (which relies on Node APIs) with the runtime's native fetch function. Pass the function into the constructor with proper binding:
```
1const client = new FingerprintJsServerApiClient({
2  region: Region.EU,
3  apiKey: apiKey,
4  fetch: fetch.bind(globalThis),
5})
```

How to install

Install the package using your favorite package manager:

NPM:

1npm i @fingerprintjs/fingerprintjs-pro-server-api

Yarn:

1yarn add @fingerprintjs/fingerprintjs-pro-server-api

pnpm:

1pnpm i @fingerprintjs/fingerprintjs-pro-server-api

Getting started

Initialize the client instance and use it to make API requests. You need to specify your Fingerprint Secret API key and the region of your Fingerprint workspace.

1import {
2  FingerprintJsServerApiClient,
3  Region,
4} from '@fingerprintjs/fingerprintjs-pro-server-api'
5
6const client = new FingerprintJsServerApiClient({
7  apiKey: '<SECRET_API_KEY>',
8  region: Region.Global,
9})
10
11// Get visit history of a specific visitor
12client.getVisits('<visitorId>').then((visitorHistory) => {
13  console.log(visitorHistory)
14})
15
16// Get a specific identification event
17client.getEvent('<requestId>').then((event) => {
18  console.log(event)
19})
20
21// Search for identification events
22client
23  .searchEvents({
24    limit: 10,
25//    pagination_key: previousSearchResult.paginationKey,
26    suspect: true,
27  })
28  .then((events) => {
29    console.log(events)
30  })

See the Examples folder for more detailed examples.

Error handling

The Server API methods can throw RequestError. When handling errors, you can check for it like this:

1import {
2  RequestError,
3  FingerprintJsServerApiClient,
4  TooManyRequestsError,
5} from '@fingerprintjs/fingerprintjs-pro-server-api'
6
7const client = new FingerprintJsServerApiClient({
8  apiKey: '<SECRET_API_KEY>',
9  region: Region.Global,
10})
11
12// Handling getEvent errors
13try {
14  const event = await client.getEvent(requestId)
15  console.log(JSON.stringify(event, null, 2))
16} catch (error) {
17  if (error instanceof RequestError) {
18    console.log(error.responseBody) // Access parsed response body
19    console.log(error.response) // You can also access the raw response
20    console.log(`error ${error.statusCode}: `, error.message)
21  } else {
22    console.log('unknown error: ', error)
23  }
24}
25
26// Handling getVisits errors
27try {
28  const visitorHistory = await client.getVisits(visitorId, {
29    limit: 10,
30  })
31  console.log(JSON.stringify(visitorHistory, null, 2))
32} catch (error) {
33  if (error instanceof RequestError) {
34    console.log(error.status, error.error)
35    if (error instanceof TooManyRequestsError) {
36      retryLater(error.retryAfter) // Needs to be implemented on your side
37    }
38  } else {
39    console.error('unknown error: ', error)
40  }
41
42  // You can also check for specific error instance
43  // if(error instanceof VisitorsError403) {
44  //    Handle 403 error...
45  // }
46}

Webhooks

Webhook types

When handling Webhooks coming from Fingerprint, you can cast the payload as the built-in VisitWebhook type:

1import { VisitWebhook } from '@fingerprintjs/fingerprintjs-pro-server-api'
2
3const visit = visitWebhookBody as unknown as VisitWebhook

Webhook signature validation

Customers on the Enterprise plan can enable Webhook signatures to cryptographically verify the authenticity of incoming webhooks. This SDK provides a utility method for verifying the HMAC signature of the incoming webhook request.

To learn more, see example/validateWebhookSignature.mjs or read the API Reference.

Sealed results

Customers on the Enterprise plan can enable Sealed results to receive the full device intelligence result on the client and unseal it on the server. This SDK provides utility methods for decoding sealed results.

To learn more, see example/unsealResult.mjs or the API Reference.

Deleting visitor data

Customers on the Enterprise plan can Delete all data associated with a specific visitor to comply with privacy regulations. See example/deleteVisitor.mjs or the API Reference.

API Reference

See the full API reference.

Support and feedback

To report problems, ask questions, or provide feedback, please use Issues. If you need private support, you can email us at oss-support@fingerprint.com.

License

This project is licensed under the MIT license.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

5

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

5

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/analyze-commits.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/analyze-commits.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/analyze-commits.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/analyze-commits.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/coverage-diff.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/coverage-diff.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/coverage-report.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/coverage-report.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e-tests.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/e2e-tests.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/e2e-tests.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/e2e-tests.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/functional_tests.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/functional_tests.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/functional_tests.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/functional_tests.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/functional_tests.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/functional_tests.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/functional_tests.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/functional_tests.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/functional_tests.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/functional_tests.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/functional_tests.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/functional_tests.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/reset-prerelease-branch.yml:7: update your workflow using https://app.stepsecurity.io/secureworkflow/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/reset-prerelease-branch.yml/main?enable=pin
Info: 0 out of 5 GitHub-owned GitHubAction dependencies pinned
Info: 1 out of 11 third-party GitHubAction dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

Score

5.3

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@fingerprintjs/fingerprintjs-pro-server-api

Installations

Developer Guide

Yes

CommonJS, ESM

>=18.17.0

21.7.3

10.5.0

Pull Requests

1

188

24

163

Issues

4

9

5

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

Fingerprint Server API Node.js SDK

Requirements

How to install

Getting started

Error handling

Webhooks

Webhook types

Webhook signature validation

Sealed results

Deleting visitor data

API Reference

Support and feedback

License

10

10

10

10

10

5

5

0

0

0

0

0

0

5.3

/10