API Reference

Complete reference for all EUREG API endpoints.

Announcements

GET/api/v1/announcements

Retrieve a paginated list of regulatory announcements. Supports filtering by jurisdiction, category, source, date range, and full-text search.

Parameter	Type	Required	Description
`jurisdiction`	string	No	ISO country code (ES, FR, DE, IT, GB, EU)
`category`	string	No	Category filter (comma-separated)
`source`	string	No	Source identifier
`date_from`	date	No	Start date (ISO 8601)
`date_to`	date	No	End date (ISO 8601)
`q`	string	No	Full-text search query
`page`	integer	No	Page number (default: 1)
`per_page`	integer	No	Results per page (1-100, default: 25)

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.eureg.io/api/v1/announcements?jurisdiction=ES&category=company_formation&per_page=5"

Response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "source_id": "es_boe",
      "publication_date": "2025-01-15",
      "jurisdiction": "ES",
      "category": "company_formation",
      "title": "Constitucion de sociedad limitada",
      "entities": [{"type": "company", "name": "Example SL"}],
      "metadata": {"capital": 3000, "currency": "EUR"}
    }
  ],
  "pagination": {"page": 1, "per_page": 5, "total": 1234, "total_pages": 247}
}

GET/api/v1/announcements/{id}

Retrieve a single announcement by its unique identifier.

Parameter	Type	Required	Description
`id`	UUID	Yes	Announcement UUID

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.eureg.io/api/v1/announcements/550e8400-e29b-41d4-a716-446655440000"

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "source_id": "es_boe",
  "source_reference": "BOE-B-2025-1234",
  "source_url": "https://www.boe.es/...",
  "publication_date": "2025-01-15",
  "jurisdiction": "ES",
  "category": "company_formation",
  "title": "Constitucion de sociedad limitada",
  "summary": "...",
  "entities": [{"type": "company", "name": "Example SL", "role": "subject"}],
  "metadata": {"capital": 3000, "currency": "EUR", "legal_form": "SL"}
}

Entities

GET/api/v1/entities

Search and filter entities (companies, people, authorities) extracted from announcements.

Parameter	Type	Required	Description
`q`	string	No	Search entity names
`type`	string	No	Entity type (company, person, authority)
`jurisdiction`	string	No	ISO country code
`tax_id`	string	No	Exact tax/registration ID
`status`	string	No	Entity status (active, dissolved, insolvent)
`page`	integer	No	Page number
`per_page`	integer	No	Results per page (1-100)

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.eureg.io/api/v1/entities?q=Iberdrola&type=company"

Response

{
  "data": [
    {
      "id": "...",
      "entity_type": "company",
      "name": "Iberdrola SA",
      "jurisdiction": "ES",
      "tax_id": "A48010615",
      "status": "active",
      "announcement_count": 127
    }
  ],
  "pagination": {"page": 1, "per_page": 25, "total": 3, "total_pages": 1}
}

GET/api/v1/entities/{id}/timeline

Retrieve a chronological timeline of all regulatory events associated with an entity.

Parameter	Type	Required	Description
`id`	UUID	Yes	Entity UUID
`page`	integer	No	Page number
`per_page`	integer	No	Events per page (1-100)

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.eureg.io/api/v1/entities/ENTITY_ID/timeline"

Response

{
  "entity": {"id": "...", "name": "Example SL", "entity_type": "company"},
  "events": [
    {
      "date": "2024-03-15",
      "category": "company_formation",
      "title": "Constitucion de sociedad",
      "source_id": "es_borme",
      "announcement_id": "..."
    },
    {
      "date": "2024-09-20",
      "category": "officer_appointment",
      "title": "Nombramiento de administrador",
      "source_id": "es_borme",
      "announcement_id": "..."
    }
  ],
  "pagination": {"page": 1, "per_page": 50, "total": 2, "total_pages": 1}
}

Search

GET/api/v1/search

Full-text search across all announcements using Elasticsearch. Returns relevance-ranked results.

Parameter	Type	Required	Description
`q`	string	Yes	Search query
`jurisdiction`	string[]	No	Filter by jurisdictions
`category`	string[]	No	Filter by categories
`date_from`	date	No	Start date
`date_to`	date	No	End date
`page`	integer	No	Page number
`per_page`	integer	No	Results per page

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.eureg.io/api/v1/search?q=insolvency+Barcelona&jurisdiction=ES"

Response

{
  "data": [
    {
      "id": "...",
      "title": "Concurso de acreedores...",
      "jurisdiction": "ES",
      "category": "insolvency_filing",
      "publication_date": "2025-01-10",
      "score": 12.5
    }
  ],
  "pagination": {"page": 1, "per_page": 25, "total": 42, "total_pages": 2},
  "query": "insolvency Barcelona"
}

Sources

GET/api/v1/sources

List all configured data sources with status, record counts, and latest data dates.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.eureg.io/api/v1/sources"

Response

{
  "sources": [
    {
      "source_id": "es_boe",
      "name": "Boletin Oficial del Estado",
      "jurisdiction": "ES",
      "url": "https://www.boe.es",
      "description": "Spanish Official State Gazette",
      "record_count": 145230,
      "latest_date": "2025-01-15"
    }
  ],
  "total_sources": 9
}

Webhooks

POST/api/v1/webhooks

Create a new webhook subscription. The signing secret is returned only on creation.

Parameter	Type	Required	Description
`url`	string	Yes	Webhook delivery URL
`events`	string[]	Yes	Event types to subscribe to
`jurisdictions`	string[]	No	Filter by jurisdictions

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/webhook", "events": ["announcement.created"]}' \
  "https://api.eureg.io/api/v1/webhooks"

Response

{
  "id": "...",
  "url": "https://example.com/webhook",
  "events": ["announcement.created"],
  "jurisdictions": [],
  "is_active": true,
  "secret": "whsec_...",
  "created_at": "2025-01-15T10:00:00Z"
}

GET/api/v1/webhooks

List all webhook subscriptions for the authenticated user.

Parameter	Type	Required	Description
`page`	integer	No	Page number
`per_page`	integer	No	Results per page

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.eureg.io/api/v1/webhooks"

Response

{
  "data": [
    {
      "id": "...",
      "url": "https://example.com/webhook",
      "events": ["announcement.created"],
      "is_active": true,
      "created_at": "2025-01-15T10:00:00Z"
    }
  ],
  "pagination": {"page": 1, "per_page": 25, "total": 1, "total_pages": 1}
}

Statistics

GET/api/v1/stats

Retrieve platform-wide statistics including total records, entity counts, and per-source breakdowns.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.eureg.io/api/v1/stats"

Response

{
  "total_announcements": 2345678,
  "total_entities": 456789,
  "sources": {
    "es_boe": {"count": 450000, "latest": "2025-01-15"},
    "fr_bodacc": {"count": 380000, "latest": "2025-01-14"},
    "eu_ted": {"count": 220000, "latest": "2025-01-15"}
  },
  "categories": {
    "company_formation": 345000,
    "insolvency_filing": 89000,
    "tender_notice": 210000
  }
}