Skip to main content

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.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.