/pappers/companies/graph

POST /api/pappers/companies/graph

Price: 20 credits

Get the corporate-network graph for a French company by SIREN

How to use it

Get the corporate-network graph for a French company by its SIREN (9-digit) or SIRET (14-digit) number: linked companies (subsidiaries, holdings, common-director companies) and people (directors, owners) as nodes plus the directed links between them.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• siren string required — French company SIREN (9 digits) or SIRET (14 digits) (examples: "652014051")
• include_managed_companies boolean — Include companies managed by the company's directors (default: true)
• include_cited_companies boolean — Include companies cited in the company's filings (default: false)
• include_sci boolean — Include related real-estate holding companies (SCI) (default: true)

Response

• @type string (default: "PappersGraph")
• siren string required
• companies array
  • @type string (default: "PappersGraphCompany")
  • node_id string required
  • siren string nullable
  • name string nullable
• people array
  • @type string (default: "PappersGraphPerson")
  • node_id string required
  • first_name string nullable
  • last_name string nullable
  • level integer nullable
  • birth_date string nullable
• company_person_links array
  • @type string (default: "PappersGraphCompanyPersonLink")
  • company_node_id string required
  • person_node_id string required
• company_company_links array
  • @type string (default: "PappersGraphCompanyCompanyLink")
  • parent_node_id string required
  • child_node_id string required

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — SIREN not found in the French company registry Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.