{"source":"skipsregister","operation":"search_vessels","description":"Search the NIS/NOR ship register by name, call sign, IMO or owner org nr. Signature: search_vessels(query: string, required; include_deleted: yes/no, optional, default False; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0).","signature":"search_vessels(query: string, required; include_deleted: yes/no, optional, default False; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0)","parameters":[{"name":"query","type":"string","schema":{"type":"string"},"required":true,"default":null,"description":"At least 3 characters, e.g. \"RICHARD WITH\", \"LGWH\" or \"9040429\".","unit":null},{"name":"include_deleted","type":"boolean","schema":{"type":"boolean"},"required":false,"default":false,"description":"Include vessels whose register status is \"Deleted\" (default false).","unit":null},{"name":"limit","type":"integer","schema":{"type":"integer"},"required":false,"default":25,"description":"Max vessels to return, 1-100 (default 25). Unit: items.","unit":"items"},{"name":"offset","type":"integer","schema":{"type":"integer"},"required":false,"default":0,"description":"Results to skip before the first one returned (default 0); with limit, pages through every match. Unit: items.","unit":"items"}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/skipsregister/search_vessels?query={query}&include_deleted=false&limit=25&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"count":{"type":"integer"},"returned":{"type":"integer"},"vessels":{"type":"array","items":{"type":"object","properties":{"vessel_id":{"type":["integer","null"]},"name":{"type":["string","null"]},"register":{"type":["string","null"]},"call_sign":{"type":["string","null"]},"imo":{"type":["integer","string","null"]},"status":{"type":["string","null"]},"shipyard":{"type":["string","null"]},"parties":{"type":"array","items":{"type":"object","properties":{"role":{"type":["string","null"]},"name":{"type":["string","null"]},"organization_id":{"type":["string","null"]}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["count","returned","vessels"]},"response_schema_status":{"status":"declared","codegen_safe":true,"description":"Maintained response contract."},"entity_projection":{"status":"projected","entity_types":["ship","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"],"retryable":false},"429":{"codes":["RATE_LIMITED","GATEWAY_RATE_LIMITED"],"retryable":true},"503":{"codes":["SOURCE_UNAVAILABLE"],"retryable":true},"500":{"codes":["INTERNAL_ERROR"],"retryable":true}}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/skipsregister/search_vessels/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/skipsregister/search_vessels","source":"https://allemannsdata.com/wiki/api/v1/kilder/skipsregister","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"},"output_fields":["count","returned","vessels","vessels[].vessel_id","vessels[].name","vessels[].register","vessels[].call_sign","vessels[].imo","vessels[].status","vessels[].shipyard","vessels[].parties","vessels[].parties[].role","vessels[].parties[].name","vessels[].parties[].organization_id"],"output_fields_truncated":false,"canonical_field_aliases":{"name":["vessels[].name","vessels[].parties[].name"]},"response_example":{"source":"skipsregister","operation":"search_vessels","parameters":{"query":"example value","include_deleted":false,"limit":25,"offset":0},"data":{"count":1,"returned":1,"vessels":[{"vessel_id":1,"name":"Example","register":"example value","call_sign":"example value","imo":1,"status":"example value","shipyard":"example value","parties":[{"role":"example value","name":"Example","organization_id":"example-id"}]}]},"entities":[],"_meta":{"retrieved_at":"2026-01-15T12:00:00Z","language":"en","content_languages":["en"],"sources":[{"id":"skipsregister","name":"Ship register (NIS/NOR)","description":"Norwegian-flagged NIS and NOR vessels with owners, dimensions, tonnage and home port, from Sj\u00f8fartsdirektoratet's ship search; the endpoint is undocumented and may change without notice.","cache_ttl_seconds":3600,"documentation":"https://skipssok.sdir.no/"}]},"_provenance":{"data":{"source":"skipsregister","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/skipsregister"},"entities":{"source":"skipsregister","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/skipsregister","derived_from":"#/data","description":"Normalized projection of data."}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/skipsregister/search_vessels","source":"https://allemannsdata.com/wiki/api/v1/kilder/skipsregister","wiki":"https://allemannsdata.com/wiki/kilder/skipsregister/search_vessels/","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"}}}
