{"_id":"@adrien1212balitrand/auros-protocol","name":"@adrien1212balitrand/auros-protocol","dist-tags":{"latest":"1.0.6"},"versions":{"1.0.6":{"name":"@adrien1212balitrand/auros-protocol","version":"1.0.6","description":"Official TypeScript SDK for the AUROS Protocol — RWA intelligence API","license":"MIT","type":"module","main":"./dist/index.cjs","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"require":{"types":"./dist/index.d.cts","default":"./dist/index.cjs"}}},"scripts":{"build":"tsup src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"keywords":["auros","rwa","mica","tokenization","api","sdk"],"repository":{"type":"git","url":"git+https://github.com/getauros/auros.git","directory":"packages/auros-protocol"},"homepage":"https://getauros.com/developers","devDependencies":{"tsup":"^8.5.0","typescript":"^5"},"engines":{"node":">=18"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"gitHead":"5bfc0a11d496ac447802f45b2087a6d8d8b17858","_id":"@adrien1212balitrand/auros-protocol@1.0.6","bugs":{"url":"https://github.com/getauros/auros/issues"},"_nodeVersion":"24.15.0","_npmVersion":"11.12.1","dist":{"integrity":"sha512-5gmTjA62YnkyNhh+0OFsMefi8jBnY9+KOOnAkdQHGXCFgpyw/Pj+gFDJi6hmzYLV2/L+3AneYewfIkq8naNNhg==","shasum":"b879c17914c2d02ef1ccd3ad9523560624fe6d2f","tarball":"https://registry.npmjs.org/@adrien1212balitrand/auros-protocol/-/auros-protocol-1.0.6.tgz","fileCount":6,"unpackedSize":69111,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIG8oszWYoHCYS55TpmUyEd4C3PmuIO6+xivcm2oV/BJnAiEAvasIsTnIIWGvE4itO16ChrLjhja5dSL1ZnREw8VI1Gg="}]},"_npmUser":{"name":"adrien1212balitrand","email":"adrien.balitrand@gmail.com"},"directories":{},"maintainers":[{"name":"adrien1212balitrand","email":"adrien.balitrand@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/auros-protocol_1.0.6_1784547982884_0.20583689247575676"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-20T11:46:22.768Z","1.0.6":"2026-07-20T11:46:23.022Z","modified":"2026-07-20T11:46:23.208Z"},"maintainers":[{"name":"adrien1212balitrand","email":"adrien.balitrand@gmail.com"}],"description":"Official TypeScript SDK for the AUROS Protocol — RWA intelligence API","homepage":"https://getauros.com/developers","keywords":["auros","rwa","mica","tokenization","api","sdk"],"repository":{"type":"git","url":"git+https://github.com/getauros/auros.git","directory":"packages/auros-protocol"},"bugs":{"url":"https://github.com/getauros/auros/issues"},"license":"MIT","readme":"# @adrien1212balitrand/auros-protocol\r\n\r\n<p align=\"center\">\r\n  <a href=\"https://getauros.com/developers\">\r\n    <img src=\"https://getauros.com/auros-logo.svg\" alt=\"AUROS\" width=\"120\" />\r\n  </a>\r\n</p>\r\n\r\nOfficial TypeScript/JavaScript SDK for the [AUROS Protocol](https://getauros.com/developers) — the RWA intelligence layer.\r\n\r\nScore MiCA readiness, browse 120+ tokenized products, rank jurisdictions, and generate compliance checklists — all via REST with typed responses.\r\n\r\n## Install\r\n\r\n```bash\r\nnpm install @adrien1212balitrand/auros-protocol\r\n```\r\n\r\n## Quickstart (< 5 min)\r\n\r\n```ts\r\nimport { AurosProtocol } from \"@adrien1212balitrand/auros-protocol\";\r\n\r\nconst client = new AurosProtocol({\r\n  apiKey: \"auros_pk_test_demo\", // demo key — 100 req/mo on free tier\r\n});\r\n\r\nconst result = await client.score({\r\n  description:\r\n    \"Retail warehouse Luxembourg €2.5M SPV professional investors whitepaper draft\",\r\n});\r\n\r\nconsole.log(result.score, result.grade, result.mica_classification);\r\n```\r\n\r\nGet your own key (free, 100 requests/month):\r\n\r\n```ts\r\nconst { api_key } = await new AurosProtocol({ apiKey: \"auros_pk_test_demo\" }).createKey({\r\n  email: \"you@company.com\",\r\n});\r\nconsole.log(api_key); // store securely — shown once\r\n```\r\n\r\n## Methods\r\n\r\n| Method | Endpoint | Auth |\r\n|--------|----------|------|\r\n| `score(body)` | `POST /api/v1/score` | Bearer |\r\n| `scoreBatch(body)` | `POST /api/v1/score/batch` | Bearer |\r\n| `products(query?)` | `GET /api/v1/products` | Bearer |\r\n| `jurisdictions(query?)` | `GET /api/v1/jurisdictions` | Bearer |\r\n| `checklist(body)` | `POST /api/v1/checklist` | Bearer |\r\n| `monitor(body)` | `POST /api/v1/monitor` | Bearer (premium) |\r\n| `getMonitor(id)` | `GET /api/v1/monitor/:id` | Bearer (premium) |\r\n| `deleteMonitor(id)` | `DELETE /api/v1/monitor/:id` | Bearer (premium) |\r\n| `dossier(body)` | `POST /api/v1/dossier` | Bearer (premium) |\r\n| `attest(body)` | `POST /api/v1/attest` | Bearer (premium) |\r\n| `verifyAttest(query)` | `GET /api/v1/attest/verify` | None |\r\n| `createChargeflowE(body)` | `POST /api/v1/chargeflow` | Bearer (premium) |\r\n| `createChargeflowW(body)` | `POST /api/v1/chargeflow/w` | Bearer (premium) |\r\n| `createChargeflowF(body)` | `POST /api/v1/chargeflow/f` | Bearer (premium) |\r\n| `createChargeflowEBatch(body)` | `POST /api/v1/chargeflow/batch` | Bearer (premium) |\r\n| `createChargeflowWBatch(body)` | `POST /api/v1/chargeflow/w/batch` | Bearer (premium) |\r\n| `createChargeflowFBatch(body)` | `POST /api/v1/chargeflow/f/batch` | Bearer (premium) |\r\n| `createChargeflowFromOcpi(body)` | `POST /api/v1/chargeflow/from-ocpi` | Bearer (premium) |\r\n| `listChargeflowPartners()` | `GET /api/v1/chargeflow/partners` | None |\r\n| `syncChargeflowPartner(body)` | `POST /api/v1/chargeflow/partners/sync` | Bearer (premium) |\r\n| `listChargeflow(query?)` | `GET /api/v1/chargeflow` | Bearer (premium) |\r\n| `getChargeflow(id)` | `GET /api/v1/chargeflow/:id` | None |\r\n| `verifyChargeflow(query)` | `GET /api/v1/chargeflow/verify` | None |\r\n| `retireChargeflow(id, body?)` | `POST /api/v1/chargeflow/:id/retire` | Bearer (premium) |\r\n| `registerWebhook(body)` | `POST /api/v1/webhooks` | Bearer (premium) |\r\n| `webhooks()` | `GET /api/v1/webhooks` | Bearer (premium) |\r\n| `deleteWebhook(id)` | `DELETE /api/v1/webhooks/:id` | Bearer (premium) |\r\n| `createKey(body)` | `POST /api/v1/keys` | None |\r\n| `greenWattScore(id)` | `GET /api/green/watt/:id` | None |\r\n| `greenCarbonQuality(id)` | `GET /api/green/carbon-quality/:id` | None |\r\n| `greenWattBatch(body)` | `POST /api/v1/green/watt/batch` | Bearer (premium) |\r\n| `greenCarbonQualityBatch(body)` | `POST /api/v1/green/carbon-quality/batch` | Bearer (premium) |\r\n\r\n## Examples\r\n\r\n### Score with structured fields\r\n\r\n```ts\r\nconst score = await client.score({\r\n  asset_type: \"real_estate\",\r\n  issuer_type: \"company_spv\",\r\n  investor_type: \"professional\",\r\n  whitepaper: \"draft\",\r\n  jurisdiction: \"luxembourg\",\r\n  value_eur: 2_500_000,\r\n  has_kyc: true,\r\n  has_data_room: false,\r\n});\r\n```\r\n\r\n### Browse RWA catalog\r\n\r\n```ts\r\nconst catalog = await client.products({\r\n  category: \"bonds\",\r\n  yield_min: 4,\r\n  sort: \"apy\",\r\n  limit: 10,\r\n});\r\n```\r\n\r\n### Rank jurisdictions\r\n\r\n```ts\r\nconst ranking = await client.jurisdictions({\r\n  asset_type: \"real_estate\",\r\n  investor_type: \"professional\",\r\n  timeline_months: 6,\r\n  budget: 50_000,\r\n});\r\n```\r\n\r\n### Compliance checklist\r\n\r\n```ts\r\nconst checklist = await client.checklist({\r\n  asset_type: \"real_estate\",\r\n  jurisdiction: \"luxembourg\",\r\n  structure: \"spv\",\r\n});\r\n```\r\n\r\n### Green Watt & CQS\r\n\r\n```ts\r\n// Public reads — no API key required on these routes (batch calls need a premium live key)\r\nconst watt = await client.greenWattScore(\"sunexchange\");\r\nconsole.log(watt.watt_score.rating, watt.watt_score.tier);\r\n\r\nconst batch = await client.greenWattBatch({\r\n  items: [\r\n    { id: \"sunexchange\" },\r\n    { text: \"Solar farm 12 MW PPA signed production MWh France\" },\r\n  ],\r\n});\r\nconsole.log(batch.succeeded, batch.items[0]);\r\n```\r\n\r\n## Configuration\r\n\r\n```ts\r\nconst client = new AurosProtocol({\r\n  apiKey: process.env.AUROS_API_KEY!,\r\n  baseUrl: \"https://getauros.com\", // default\r\n  fetch: customFetch, // optional — for Node < 18 or testing\r\n});\r\n```\r\n\r\n## Errors\r\n\r\n```ts\r\nimport { AurosProtocolError } from \"@adrien1212balitrand/auros-protocol\";\r\n\r\ntry {\r\n  await client.score({ description: \"short\" });\r\n} catch (err) {\r\n  if (err instanceof AurosProtocolError) {\r\n    console.log(err.code, err.status, err.message);\r\n    // unauthorized | quota_exceeded | validation_error | ...\r\n  }\r\n}\r\n```\r\n\r\n## Publishing (maintainers)\r\n\r\n```bash\r\ncd packages/auros-protocol\r\nnpm run build\r\nnpm login\r\nnpm publish --access public\r\n```\r\n\r\nRequires `NPM_TOKEN` in CI or interactive `npm login`. Do not publish without org approval.\r\n\r\n## Disclaimer\r\n\r\nResponses are **indicative intelligence only** — not legal, tax, or investment advice. Validate with qualified counsel before any issuance.\r\n\r\n## Links\r\n\r\n- [Developer docs](https://getauros.com/developers/docs)\r\n- [OpenAPI spec](https://getauros.com/auros-openapi.yaml)\r\n- [Playground](https://getauros.com/developers#playground)\r\n","readmeFilename":"README.md","_rev":"1-1f2fd4f26a813bbc4f4596c61a6b2cfd"}