{"source":"sodir","operation":"search_companies","description":"Search companies registered as operators or licensees on the shelf. Signature: search_companies(name: string, optional, default None; organization_id: string, optional, default None; current_operator_only: yes/no, optional, default False; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0).","signature":"search_companies(name: string, optional, default None; organization_id: string, optional, default None; current_operator_only: yes/no, optional, default False; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0)","parameters":[{"name":"name","type":"string","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Partial company name, e.g. \"aker\" or \"Equinor\".","unit":null},{"name":"organization_id","type":"string","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Norwegian organisation number (9 digits), exact match. One number can return several rows: Sodir keeps the entity's former names (Statoil, Den norske stats oljeselskap) alongside the current one.","unit":null},{"name":"current_operator_only","type":"boolean","schema":{"type":"boolean"},"required":false,"default":false,"description":"True to keep only companies that currently operate at least one production licence.","unit":null},{"name":"limit","type":"integer","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"required":false,"default":25,"description":"Maximum companies to return (default 25, maximum 100). Unit: items. Through this API: default 25, maximum 100.","unit":"items"},{"name":"offset","type":"integer","schema":{"type":"integer"},"required":false,"default":0,"description":"Rows to skip before the first returned row (default 0). Unit: items.","unit":"items"}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/sodir/search_companies?name={name}&organization_id={organization_id}&current_operator_only=false&limit=25&offset=0","example_url":"https://allemannsdata.com/wiki/api/v1/kilder/sodir/search_companies?name=Equinor","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"count":{"type":"integer"},"returned":{"type":"integer"},"companies":{"type":"array","items":{"type":"object","properties":{"company":{"type":["string","null"]},"short_name":{"type":["string","null"]},"organization_id":{"type":["string","null"]},"nation":{"type":["string","null"]},"is_current_licence_operator":{"type":["boolean","null"]},"is_current_licensee":{"type":["boolean","null"]},"was_licence_operator":{"type":["boolean","null"]},"was_licensee":{"type":["boolean","null"]},"petroleum_id":{"type":["string","null"]}},"additionalProperties":false}},"note":{"type":["string","null"]}},"additionalProperties":false,"required":["count","returned","companies"]},"response_schema_status":{"status":"declared","codegen_safe":true,"description":"Maintained response contract."},"entity_projection":{"status":"projected","entity_types":["organization"],"description":"Recognized records and stable operation identifiers are projected; an empty array means the successful payload contained no recognizable entity."},"error_contract":{"scope":"top-level HTTP error response; never part of a success payload","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object"}},"additionalProperties":false,"required":["code","message","retryable"]},"suggestion":{"type":"string"},"_meta":{"type":"object","properties":{"retrieved_at":{"type":"string","format":"date-time"},"language":{"type":"string","const":"en"},"content_languages":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"type":"object"}}},"required":["retrieved_at","language","content_languages","sources"]},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"api_index":{"type":"string","format":"uri"},"feedback":{"type":"string","format":"uri"}},"required":["self","api_index","feedback"],"additionalProperties":false}},"additionalProperties":false,"required":["error","suggestion","_meta","_links"]},"statuses":{"400":{"codes":["MISSING_PARAMETER","INVALID_PARAMETER","INVALID_REQUEST"],"retryable":false},"404":{"codes":["SOURCE_NOT_FOUND","OPERATION_NOT_FOUND","ENTITY_NOT_FOUND","ENDPOINT_NOT_FOUND"],"retryable":false},"405":{"codes":["METHOD_NOT_ALLOWED"],"retryable":false},"429":{"codes":["RATE_LIMITED","GATEWAY_RATE_LIMITED"],"retryable":true},"503":{"codes":["SOURCE_UNAVAILABLE"],"retryable":true},"500":{"codes":["INTERNAL_ERROR"],"retryable":false}}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/sodir/search_companies/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/sodir/search_companies","source":"https://allemannsdata.com/wiki/api/v1/kilder/sodir","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"},"output_fields":["count","returned","companies","companies[].company","companies[].short_name","companies[].organization_id","companies[].nation","companies[].is_current_licence_operator","companies[].is_current_licensee","companies[].was_licence_operator","companies[].was_licensee","companies[].petroleum_id","note"],"output_fields_truncated":false,"canonical_field_aliases":{},"response_example":{"source":"sodir","operation":"search_companies","parameters":{"name":"Equinor","limit":25,"offset":0},"data":{"count":1,"returned":1,"companies":[{"company":"example value","short_name":"Example","organization_id":"example-id","nation":"example value","is_current_licence_operator":true,"is_current_licensee":true,"was_licence_operator":true,"was_licensee":true,"petroleum_id":"example-id"}],"note":"example value"},"entities":[],"_meta":{"retrieved_at":"2026-01-15T12:00:00Z","language":"en","content_languages":["en"],"sources":[{"id":"sodir","name":"Sokkeldirektoratet factpages","description":"Fields, production, reserves, wellbores, discoveries, production licences, companies and offshore facilities on the Norwegian continental shelf.","publisher":"Sokkeldirektoratet (Norwegian Offshore Directorate)","license":"https://data.norge.no/nlod/en/2.0/","cache_ttl_seconds":3600,"documentation":"https://www.sodir.no/fakta/om-oss/apne-data/faktasider-og-faktakart-teknisk-informasjon/"}]},"_provenance":{"data":{"source":"sodir","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/sodir"},"entities":{"source":"sodir","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/sodir","derived_from":"#/data","description":"Normalized projection of data."}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/sodir/search_companies","source":"https://allemannsdata.com/wiki/api/v1/kilder/sodir","wiki":"https://allemannsdata.com/wiki/kilder/sodir/search_companies/","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"}}}
