Skip to main content
Portal

Changelog

All notable changes to the Elfa API will be documented in this page.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[2.7.2]​

Removed​

  • includeCredits on List Queries: GET /v2/auto/queries no longer accepts the includeCredits query parameter, and no longer returns a per-item credits field. It was opt-in because it cost an extra database join the listing does not otherwise need, and it reported 0 for API-key callers regardless — builder-chat sessions in the API namespace are persisted against the key rather than the resolved user. For per-plan credits use Poll Query, which is unchanged; for what a single request cost, read the x-elfa-credits response header (see How credits work).

[2.7.1]​

Removed​

  • Market Events out of the OpenAPI spec: GET /v2/data/market-events is no longer published in swagger.json. The route itself is unchanged — it still answers 403, pointing Enterprise enquiries at [email protected] — but the spec only carried the access stub, with no parameters and no response schema, so the generated REST page added a contentless duplicate of the full Market Events reference. That reference is now the only Market Events page.

[2.7.0]​

Deprecated​

  • Smart Stats: GET /v2/account/smart-stats and GET /x402/v2/account/smart-stats are marked legacy and are scheduled for removal on 28 October 2026. The operations now carry deprecated: true in the spec, so generated SDK clients surface the warning. Behavior is unchanged until removal.

Changed​

  • Token news title: The endpoint summary is now "Token news mentions (tweet source only)". The source is X posts from accounts tagged as news sources, not articles from news outlets. URL, parameters, and response shape are unchanged.
  • x402 Builder chat pricing text: POST /v2/auto/chat documented x402 pricing as 5 credits (fast) / 18 credits (expert). That has not been the price since 2.3.0 — x402 chat quotes USD per turn, exact at $1 fast / $2 expert or upto with a $2 / $6 ceiling that settles the turn's actual cost. The cost section now describes both schemes. Credit pricing for Auto query creation is unchanged.

[2.6.3]​

Changed​

  • Credit price: A credit is $0.0145, up from $0.009. x402 endpoint prices move with it — 1 credit is $0.0145, 5 credits $0.0725, 18 credits $0.261 — and the cost lines in the spec were updated to match. Accounts already on PAYG keep $0.009 per credit until 28 September 2026, 16:00 UTC (29 September, 00:00 SGT); x402 has no accounts, so its price applies to every payer at once. See Pricing.

[2.6.2]​

Removed​

  • Auto exchange routes: GET /v2/auto/exchanges, POST /v2/auto/exchanges, and DELETE /v2/auto/exchanges/{exchange} are removed.
  • Auto request signing: HMAC signing is no longer used on Auto routes. The x-elfa-timestamp and x-elfa-signature headers are gone; x-elfa-api-key alone authorizes every Auto request, including mutations.

[2.6.1]​

Changed​

  • Symbol validation: GET /v2/auto/validate-symbol/{exchange}/{symbol} resolves through Prism instead of Mercury. Supported exchange values are hyperliquid, gmx, and binance.

[2.6.0]​

Added​

  • Market events endpoint: New GET /v2/data/market-events endpoint, gated by the data/market-events API key scope

[2.5.0]​

Added​

  • Per-request cost disclosure: Every /v2/* response to an authenticated request now returns an x-elfa-credits header with the credits that request consumed — no more diffing /v2/key-status before and after a call. Requests rejected before the key resolves carry no header, since nothing was charged. See How credits work.
  • credits on Builder Chat: POST /v2/auto/chat returns a credits field in the response body carrying the same total as the header. Builder Chat is dynamically priced, so read it rather than assuming a flat per-call cost.
  • Response compatibility policy: Response bodies and headers are documented as extensible — optional fields and headers are added without a version bump, and clients should ignore what they do not recognise. See Response compatibility.

Changed​

  • OpenAPI response schemas are no longer closed: The published spec previously emitted additionalProperties: false on response schemas, which made codegen'd and strict clients reject additive fields. Response schemas are now open; request schemas stay strict.

Fixed​

  • SDK types for credits: @elfa-ai/sdk 5.1.0 and elfa-sdk (Python) 5.1.0 declare credits on the Builder Chat response. Neither SDK rejected the field before this — both pass unknown fields through — but it was untyped.

[2.4.0]​

Deprecated​

  • V1 API: V1 is being retired — use the V2 endpoints (or the @elfa-ai/sdk). The V1-to-V2 migration guide has been removed.

[2.3.1]​

Added​

  • timeWindow parameter: Added optional timeWindow parameter to getTokenNews() method for time-based filtering
  • Default timeWindow values: API now provides default "7d" values for time window parameters across multiple endpoints

Changed​

  • Token news interface: Enhanced TokenNewsParams interface to support time window filtering
  • API parameter defaults: Updated swagger schema with default time window values for improved usability

[2.3.0]​

Added​

  • Event summary endpoint: New endpoint for event-based data aggregation
  • Reposts parameter: Added support for repost filtering in V2 client methods
  • Repost breakdown field: Enhanced response data with repost analytics

Changed​

  • Mention schema update: Replaced SanitizedMention with MentionV2 for improved clarity and consistency
  • Test coverage: Expanded test coverage for reposts parameter functionality

Fixed​

  • Schema updates: Updated Swagger documentation to reflect latest API changes

[2.2.0]​

Added​

  • Smart follower count: New field in smart account statistics
  • Enhanced linting: Implemented comprehensive ESLint configuration with pre-commit hooks
  • Code formatting: Added Prettier integration with lint-staged for consistent code style

Changed​

  • Smart stats response structure: Updated response format with additional fields for better analytics
  • Development workflow: Added pre-commit hooks for code quality enforcement

Fixed​

  • TrendingContractAddress interface: Removed deprecated changePercent field
  • Top mentions schema: Fixed return schema validation issues

[2.1.0]​

Added​

  • Smart follower count: Enhanced account statistics with follower tracking
  • Production schema: Updated to use production Swagger schema

Fixed​

  • Top mentions schema: Hotfix for schema validation issues
  • HTTP client tests: Fixed test reliability issues

[2.0.2]​

Fixed​

  • SDK version: Version alignment fixes
  • Build process: Improved build reliability

[2.0.1]​

Fixed​

  • Mapping fixes: Corrected data mapping issues
  • CI updates: Enhanced continuous integration pipeline

[2.0.0] - API V2 Release​

Added​

  • New V2 API endpoints with enhanced data privacy compliance
  • Contract address trending endpoints: /v2/aggregations/trending-cas/twitter and /v2/aggregations/trending-cas/telegram
  • Account filtering: New accountName parameter for keyword mentions search
  • Consistent response format: All V2 endpoints return {success, data, metadata} structure
  • Enhanced pagination: Cursor-based pagination for search endpoints, page-based for aggregations
  • Improved metadata: Enhanced response metadata with pagination info
  • TypeScript SDK: Official TypeScript SDK for Elfa API v2
  • Dual client architecture: ElfaV2Client with optional TwitterClient enhancement
  • V1 compatibility layer: Drop-in replacement for legacy code migration
  • Response enhancement system: Enriches V2 data with Twitter content when available

Changed​

  • Endpoint paths: All V2 endpoints use /v2/ prefix
  • Response format: Standardized response structure across all endpoints
  • Pagination patterns: Different patterns for search vs aggregation endpoints
  • Token news endpoint: Now uses page + pageSize instead of just page
  • Top mentions: Account details always included (removed includeAccountDetails parameter)

Deprecated​

  • V1 API endpoints: All V1 endpoints are deprecated in favor of V2 equivalents
  • V1 mentions search: Use /v2/data/keyword-mentions instead of /v1/mentions/search

Removed​

  • Raw tweet content: Removed from all V2 endpoints for platform ToS compliance
  • Tweet text/content fields: No longer available in any V2 responses
  • isNews parameter: Removed from token news endpoint (V2 only returns news)
  • includeAccountDetails parameter: Removed from top mentions (always included)

Security​

  • Enhanced data privacy: Raw social media content removed to comply with platform Terms of Service
  • Sanitized responses: Only metadata and engagement metrics provided

[1.0.0] - Initial Release​

Added​

  • Initial API documentation structure
  • REST API reference documentation
  • Authentication and rate limiting documentation
  • V1 API endpoints for trending tokens, mentions search, and account stats

For questions about API changes or deprecations, please contact our support team.