{"openapi":"3.1.0","info":{"title":"ProsperaData API","version":"1.0.0","description":"B2B company search for AI agents. A unique company costs one company credit per billing period regardless of requested fields; repeat access in the same period is free."},"servers":[{"url":"https://api.prosperadata.com"}],"security":[{"bearerApiKey":[]}],"components":{"securitySchemes":{"bearerApiKey":{"type":"http","scheme":"bearer","bearerFormat":"ProsperaData API key"}},"schemas":{"CompanySearchRequest":{"type":"object","required":["country"],"anyOf":[{"required":["query"]},{"required":["offerTerms"]}],"additionalProperties":false,"properties":{"country":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"PT"},"query":{"type":"string","minLength":2,"maxLength":500},"offerTerms":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","minLength":2,"maxLength":80}},"locality":{"type":"string","minLength":2,"maxLength":120},"fields":{"type":"array","uniqueItems":true,"default":["name","domain","website","country","activity","offerings"],"items":{"type":"string","enum":["name","legal_name","domain","website","country","address","city","municipality","province","postal_code","activity","sector","offerings","brands","business_email","phone","contact_page","evidence"]}},"limit":{"type":"integer","minimum":1,"maximum":100,"default":20},"cursor":{"type":"string","minLength":8,"maxLength":1000}}},"CompanyLookupRequest":{"type":"object","required":["country","domain"],"additionalProperties":false,"properties":{"country":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"PT"},"domain":{"type":"string","minLength":3,"maxLength":253},"fields":{"type":"array","uniqueItems":true,"default":["name","domain","website","country","activity","offerings"],"items":{"type":"string","enum":["name","legal_name","domain","website","country","address","city","municipality","province","postal_code","activity","sector","offerings","brands","business_email","phone","contact_page","evidence"]}}}},"SimilarCompaniesRequest":{"type":"object","required":["country","domain"],"additionalProperties":false,"properties":{"country":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"PT"},"domain":{"type":"string","minLength":3,"maxLength":253},"fields":{"type":"array","uniqueItems":true,"default":["name","domain","website","country","activity","offerings"],"items":{"type":"string","enum":["name","legal_name","domain","website","country","address","city","municipality","province","postal_code","activity","sector","offerings","brands","business_email","phone","contact_page","evidence"]}},"limit":{"type":"integer","minimum":1,"maximum":100,"default":20}}},"CountCompaniesRequest":{"type":"object","required":["country"],"anyOf":[{"required":["query"]},{"required":["offerTerms"]}],"additionalProperties":false,"properties":{"country":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"PT"},"query":{"type":"string","minLength":2,"maxLength":500},"offerTerms":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","minLength":2,"maxLength":80}},"locality":{"type":"string","minLength":2,"maxLength":120}}},"FieldEvidence":{"type":"object","required":["field","source","confidence"],"additionalProperties":false,"properties":{"field":{"type":"string","enum":["name","legal_name","domain","website","country","address","city","municipality","province","postal_code","activity","sector","offerings","brands","business_email","phone","contact_page","evidence"]},"source":{"type":"string","enum":["company_site","classification","crm_company_record","derived"]},"source_url":{"type":"string","format":"uri"},"observed_at":{"type":"string","format":"date-time"},"confidence":{"type":"string","enum":["published","classified","derived"]}}},"Company":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"legal_name":{"type":"string"},"domain":{"type":"string"},"website":{"type":"string","format":"uri"},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"PT"},"address":{"type":"string"},"city":{"type":"string"},"municipality":{"type":"string"},"province":{"type":"string"},"postal_code":{"type":"string"},"activity":{"type":"string"},"sector":{"type":"string"},"offerings":{"type":"array","items":{"type":"string"}},"brands":{"type":"array","items":{"type":"string"}},"business_email":{"type":"string","format":"email"},"phone":{"type":"string"},"contact_page":{"type":"string","format":"uri"},"evidence":{"type":"array","items":{"$ref":"#/components/schemas/FieldEvidence"}}}},"SearchResponse":{"type":"object","required":["companies","recordsReturned","companiesCharged","remainingCompanyCredits","allowance","truncated"],"additionalProperties":false,"properties":{"companies":{"type":"array","items":{"$ref":"#/components/schemas/Company"}},"recordsReturned":{"type":"integer","minimum":0},"companiesCharged":{"type":"integer","minimum":0},"remainingCompanyCredits":{"type":["integer","null"],"minimum":0},"allowance":{"type":["integer","null"],"minimum":0},"truncated":{"type":"boolean"},"nextCursor":{"type":"string"}}},"CompanyLookupResponse":{"type":"object","required":["company","companiesCharged","remainingCompanyCredits","allowance"],"additionalProperties":false,"properties":{"company":{"$ref":"#/components/schemas/Company"},"companiesCharged":{"type":"integer","minimum":0,"maximum":1},"remainingCompanyCredits":{"type":["integer","null"],"minimum":0},"allowance":{"type":["integer","null"],"minimum":0}}},"CountResponse":{"type":"object","required":["count","billedCompanyCredits","exact"],"additionalProperties":false,"properties":{"count":{"type":"integer","minimum":0},"billedCompanyCredits":{"const":0},"exact":{"const":true}}},"UsageResponse":{"type":"object","required":["plan","billingPeriodStart","allowance","used","remaining"],"additionalProperties":false,"properties":{"plan":{"type":"string"},"billingPeriodStart":{"type":"string","format":"date"},"allowance":{"type":["integer","null"]},"used":{"type":"integer","minimum":0},"remaining":{"type":["integer","null"],"minimum":0}}}}},"paths":{"/v1/companies/search":{"post":{"operationId":"searchCompanies","summary":"Search companies","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySearchRequest"}}}},"responses":{"200":{"description":"Search result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"400":{"description":"Invalid request"},"401":{"description":"Invalid or missing API key"},"403":{"description":"Insufficient scope"},"413":{"description":"Request body too large"},"429":{"description":"Rate limit exceeded"},"500":{"description":"Internal service error"}}}},"/v1/companies/get":{"post":{"operationId":"getCompany","summary":"Get a company by country and domain","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyLookupRequest"}}}},"responses":{"200":{"description":"Company result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyLookupResponse"}}}},"400":{"description":"Invalid request"},"401":{"description":"Invalid or missing API key"},"403":{"description":"Insufficient scope"},"404":{"description":"Company not found"},"413":{"description":"Request body too large"},"429":{"description":"Rate limit exceeded"},"500":{"description":"Internal service error"}}}},"/v1/companies/similar":{"post":{"operationId":"findSimilarCompanies","summary":"Find similar companies","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimilarCompaniesRequest"}}}},"responses":{"200":{"description":"Similar companies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"400":{"description":"Invalid request"},"401":{"description":"Invalid or missing API key"},"403":{"description":"Insufficient scope"},"413":{"description":"Request body too large"},"429":{"description":"Rate limit exceeded"},"500":{"description":"Internal service error"}}}},"/v1/companies/count":{"post":{"operationId":"countCompanies","summary":"Count matching companies without company-credit charge","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountCompaniesRequest"}}}},"responses":{"200":{"description":"Exact count","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResponse"}}}},"400":{"description":"Invalid request"},"401":{"description":"Invalid or missing API key"},"403":{"description":"Insufficient scope"},"413":{"description":"Request body too large"},"429":{"description":"Rate limit exceeded"},"500":{"description":"Internal service error"}}}},"/v1/usage":{"get":{"operationId":"getUsage","summary":"Current company-credit usage","responses":{"200":{"description":"Usage summary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}},"401":{"description":"Invalid or missing API key"},"429":{"description":"Rate limit exceeded"},"500":{"description":"Internal service error"}}}},"/openapi.json":{"get":{"security":[],"operationId":"getOpenApi","summary":"OpenAPI document","responses":{"200":{"description":"OpenAPI 3.1 document"}}}}}}