Quickstart-Anleitung

Create a free VynCo account — no credit card required. Then navigate to the API Keys page in your dashboard and create a new key. The free tier gives you 1,000 credits per month to explore the API.

Use GET /companies to search the Zefix registry. Pass a company name in the search parameter. Each lookup costs 1 credit.

curl "https://api.vynco.ch/v1/companies?search=Nestl%C3%A9&pageSize=5" \
  -H "Authorization: Bearer vc_live_abc123..."

Narrow results by canton, legal form, and status. Combine multiple filters in a single request.

# Filter by canton and legal form
curl "https://api.vynco.ch/v1/companies?canton=ZH&legalForm=AG&status=ACTIVE&pageSize=10" \
  -H "Authorization: Bearer vc_live_abc123..."
# Sort by registration date descending
curl "https://api.vynco.ch/v1/companies?canton=GE&sortBy=registrationDate&sortDesc=true" \
  -H "Authorization: Bearer vc_live_abc123..."

Fetch the full profile of a specific company using its UID (format: CHE-xxx.xxx.xxx). Enriched profiles include share capital, purpose, and address details and cost 5 credits.

curl "https://api.vynco.ch/v1/companies/CHE-109.322.551" \
  -H "Authorization: Bearer vc_live_abc123..."

{
  "uid": "CHE-109.322.551",
  "name": "Nestlé S.A.",
  "legalForm": "AG",
  "status": "ACTIVE",
  "canton": "VD",
  "registrationDate": "1866-09-16",
  "address": {
    "street": "Avenue Nestlé 55",
    "city": "Vevey",
    "postalCode": "1800",
    "canton": "VD"
  },
  "purpose": "La Société a pour but la fabrication et la vente de produits alimentaires...",
  "shareCapital": 322000000,
  "currency": "CHF"
}

Monitor your credit consumption at any time with the balance endpoint. Credits are also returned in every response via the X-Credits-Remaining header.

curl "https://api.vynco.ch/v1/credits/balance" \
  -H "Authorization: Bearer vc_live_abc123..."

{
  "balance": 48750,
  "tier": "Starter",
  "periodStart": "2026-03-01T00:00:00Z",
  "periodEnd": "2026-03-31T23:59:59Z"
}

Once you have data flowing, unlock deeper insights with the analytics endpoints. Run POST /analytics/cluster for K-Means or GMM clustering (15 credits), POST /analytics/anomalies for anomaly detection (15 credits), or GET /analytics/cohorts for cohort breakdowns by canton, legal form, founding year, or auditor (20 credits). These endpoints require the Professional tier or above.

# Run K-Means clustering on Zurich companies
curl -X POST "https://api.vynco.ch/v1/analytics/cluster" \
  -H "Authorization: Bearer vc_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"algorithm":"kmeans","k":5,"canton":"ZH"}'

# Cohort analysis grouped by legal form
curl "https://api.vynco.ch/v1/analytics/cohorts?groupBy=legal_form" \
  -H "Authorization: Bearer vc_live_abc123..."

The full OpenAPI 3.0 specification is available at GET /api/v1/openapi.json — no authentication required. Use it to generate typed SDKs, import into Postman or Insomnia, or browse with Swagger UI. All endpoints, parameters, response schemas, and credit costs are machine-readable.

# Download the full OpenAPI 3.0 spec (no auth required)
curl "https://api.vynco.ch/api/v1/openapi.json" -o openapi.json

You have made your first VynCo API calls. Explore these resources to go further.