# @finos/fdc3-get-agent

> Contains the main entry point for the Financial Desktop Connectivity and Collaboration Consortium (FDC3) JavaScript API, via the `getAgent` function.

Latest version **2.2.3** (published 2026-05-14) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @finos/fdc3-get-agent
pnpm add @finos/fdc3-get-agent
yarn add @finos/fdc3-get-agent
bun add @finos/fdc3-get-agent
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.2.3 |
| Published | 2026-05-14 |
| First published | 2025-01-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 136.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 275 |
| Author | Fintech Open Source Foundation |
| Maintainers | finos-admin, maoo, texodus, neil.slinger |

## Links

- npm: https://www.npmjs.com/package/@finos/fdc3-get-agent
- Repository: https://github.com/finos/FDC3
- Homepage: https://fdc3.finos.org
- Issues: https://github.com/finos/FDC3/issues
- npm.io page: https://npm.io/package/@finos/fdc3-get-agent

## Dependencies (6)

- [uuid](https://npm.io/package/uuid.md) ^14.0.0
- [@types/uuid](https://npm.io/package/@types/uuid.md) ^10.0.0
- [@finos/fdc3-schema](https://npm.io/package/@finos/fdc3-schema.md) 2.2.3
- [@finos/fdc3-context](https://npm.io/package/@finos/fdc3-context.md) 2.2.3
- [@finos/fdc3-standard](https://npm.io/package/@finos/fdc3-standard.md) 2.2.3
- [@finos/fdc3-agent-proxy](https://npm.io/package/@finos/fdc3-agent-proxy.md) 2.2.3

## Recent versions

- 2.2.3 (latest) — 2026-05-14
- 3.0.0-beta.1 (prerelease) — 2026-10-07
- 3.0.0-alpha.5 — 2026-09-23
- 3.0.0-alpha.4 — 2026-09-22
- 3.0.0-alpha.2 — 2026-06-22
- 2.2.2 — 2026-04-22
- 2.2.2-beta.2 — 2026-04-16
- 2.2.2-beta.1 — 2026-04-14
- 2.2.1-beta.3 — 2025-06-10
- 2.2.1-beta.2 — 2025-06-02
- 2.2.1 — 2025-06-02
- 2.2.0 — 2025-04-08
- 2.2.0-beta.4 — 2025-04-07
- 2.2.0-beta.3 — 2025-03-10
- 2.2.0-beta.2 — 2025-03-10
- … 4 more at https://npm.io/package/@finos/fdc3-get-agent/versions

## README

# FDC3 Agent Proxy

Contains the main entry point for the Financial Desktop Connectivity and Collaboration Consortium (FDC3) JavaScript API, via the `getAgent` function.


## Installation

To install the FDC3 module, use npm:

```bash
npm install @finos/fdc3-get-agent
```

## Usage

To use the FDC3 module in your project, import it as follows:

```javascript
import { getAgent } from '@finos/fdc3-get-agent';
// getAgent() returns the FDC3 Desktop Agent
const fdc3 = await getAgent();

// Example usage
const contact = {
  type: 'fdc3.contact',
  name: 'Jane Doe',
  id: {
    email: 'jane@mail.com'
  }
};

fdc3.raiseIntent('ViewProfile', contact);
```

## Documentation

For detailed documentation and API reference, please visit the [official FDC3 documentation](https://fdc3.finos.org/docs/api/spec).

## Contributing

We welcome contributions to the FDC3 project. Please see our [contributing guidelines](https://github.com/finos/FDC3/blob/main/CONTRIBUTING.md) for more information.

## License

This project is licensed under the [Apache 2.0 License](LICENSE).

## Contact

For any questions or support, please reach out to the FDC3 community on our [Slack channel](https://finos-lf.slack.com/archives/CJ8Q8H4Q1) or [mailing list](mailto:fdc3@finos.org).

## Further Details

Further details are avilable in the main [FDC3 Project README](https://github.com/finos/FDC3)

---
_Source: https://npm.io/package/@finos/fdc3-get-agent · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._