Skip to main content
This page will describe the notation used across all Intention API endpoints: field types, JSON encoding rules, naming conventions, integer-vs-decimal handling, timestamp formats, and how request and response examples are presented in the rest of the reference.
Status: not yet published. The notation conventions will be finalized alongside the first stable API release. Until then, treat the descriptions on this site as planning documentation rather than a formal specification.

​
What this page will contain

When the API ships, this page will document:
  • Primitive types. How integers, decimals, booleans, strings, hashes, and addresses are represented in JSON.
  • Decimal handling. Why all monetary fields are transmitted as strings, and how clients should parse them. See also tick and lot and Precision.
  • Timestamps. Block times, wall-clock times, and millisecond precision.
  • Naming. Snake-case versus camelCase, plural versus singular collection names, and field-name stability guarantees.
  • Versioning. How endpoint versions are exposed and how breaking changes will be announced.
  • Examples. The format used for request and response samples on REST and WebSocket endpoint pages.

​
Contact

For early integration questions, email contact@intention.xyz.