eventcrawler-api-sdk
v1.0.1
Published
TypeScript SDK for EventCrawler v2 API - News and event aggregation with AI analysis
Downloads
20
Maintainers
Readme
EventCrawler API TypeScript SDK
TypeScript SDK for the EventCrawler v2 API - News and event aggregation with AI analysis.
Installation
npm install eventcrawler-api-sdkUsage
import { Configuration, EventsApi } from 'eventcrawler-api-sdk';
// Configure the API client
const config = new Configuration({
basePath: 'https://eventcrawler-api.arkturian.com'
});
// Create API instance
const eventsApi = new EventsApi(config);
// Fetch events
async function fetchEvents() {
const response = await eventsApi.listEventsApiV1EventsGet({ limit: 100 });
console.log('Events:', response.data);
}Available APIs
- EventsApi - Fetch and manage events
- CandidatesApi - Manage crawl candidates
- SourcesApi - Manage news sources
- SchedulerApi - Control the crawler scheduler
- PipelinesApi - Trigger processing pipelines
- DebugApi - Debug and admin endpoints
API Endpoints
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- EventsApi | listEventsApiV1EventsGet | GET /api/v1/events/ | List Events EventsApi | getEventApiV1EventsEventIdGet | GET /api/v1/events/{event_id} | Get Event EventsApi | getEventByUuidApiV1EventsUuidEventUuidGet | GET /api/v1/events/uuid/{event_uuid} | Get Event By UUID CandidatesApi | listCandidatesApiV1CandidatesGet | GET /api/v1/candidates/ | List Candidates SourcesApi | listSourcesApiV1SourcesGet | GET /api/v1/sources/ | List Sources
Models
- Event - News/event item with AI-generated summaries and media
- CrawlCandidate - Candidate URLs pending processing
- Source - News source configuration
API Documentation
Full API documentation is available at:
- OpenAPI Spec: https://eventcrawler-api.arkturian.com/openapi.json
- Swagger UI: https://eventcrawler-api.arkturian.com/docs
Auto-Generated
This SDK is auto-generated from the OpenAPI specification using OpenAPI Generator.
When the API changes, a new version is automatically generated and published to NPM.
License
UNLICENSED - Arkturian Internal Use
