{"source":"kystdatahuset","operation":"search_ships","description":"Search Kystverket's combined ship registry by free text (ship name, and\nidentifiers where indexed). Signature: search_ships(query: string, required; limit: integer, items, optional, default 20; offset: integer, items, optional, default 0).","signature":"search_ships(query: string, required; limit: integer, items, optional, default 20; offset: integer, items, optional, default 0)","parameters":[{"name":"query","type":"string","schema":{"type":"string"},"required":true,"default":null,"description":"Free-text term, e.g. a ship name (\"color fantasy\") or fragment.","unit":null},{"name":"limit","type":"integer","schema":{"type":"integer"},"required":false,"default":20,"description":"Max ships to return, 1-100 (default 20). Unit: items.","unit":"items"},{"name":"offset","type":"integer","schema":{"type":"integer","minimum":0,"default":0},"display_type":"integer","required":false,"default":0,"description":"Number of list items to skip before returning the page.","unit":"items"}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/kystdatahuset/search_ships?query={query}&limit=20&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"count":{"type":"integer"},"returned":{"type":"integer"},"ships":{"type":"array","items":{"type":"object","properties":{"shipname":{"type":"string"},"vessel_id":{"type":["integer","array"],"items":{"type":"integer"}},"imo":{"type":["integer","array"],"items":{"type":"integer"}},"callsign":{"type":["string","array"],"items":{"type":"string"}},"shiptype":{"type":"string"},"flag":{"type":"string"},"loa":{"type":"number"},"breadth":{"type":"number"},"gt":{"type":"number"},"dwt":{"type":"number"},"teu":{"type":"number"},"yearofbuild":{"type":"integer"},"speedservice":{"type":"number"}},"additionalProperties":false}}},"additionalProperties":false,"required":["count","returned","ships"]},"response_schema_status":{"status":"declared","codegen_safe":true,"description":"Maintained response contract."},"entity_projection":{"status":"projected","entity_types":["port"],"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},"502":{"codes":["SOURCE_UNAVAILABLE"],"retryable":true},"500":{"codes":["INTERNAL_ERROR"],"retryable":true}}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/kystdatahuset/search_ships/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/kystdatahuset/search_ships","source":"https://allemannsdata.com/wiki/api/v1/kilder/kystdatahuset","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"},"output_fields":["count","returned","ships","ships[].shipname","ships[].vessel_id","ships[].imo","ships[].callsign","ships[].shiptype","ships[].flag","ships[].loa","ships[].breadth","ships[].gt","ships[].dwt","ships[].teu","ships[].yearofbuild","ships[].speedservice"],"output_fields_truncated":false,"canonical_field_aliases":{},"response_example":{"source":"kystdatahuset","operation":"search_ships","parameters":{"query":"example value","limit":20},"data":{"count":1,"returned":1,"ships":[{"shipname":"Example","vessel_id":1,"imo":1,"callsign":"example value","shiptype":"example value","flag":"example value","loa":1.0,"breadth":1.0,"gt":1.0,"dwt":1.0,"teu":1.0,"yearofbuild":1,"speedservice":1.0}]},"entities":[],"_meta":{"retrieved_at":"2026-01-15T12:00:00Z","language":"en","content_languages":["en"],"sources":[{"id":"kystdatahuset","name":"Kystdatahuset","description":"Norwegian ports, quays, maritime locations and reported port connections from the Coastal Administration.","cache_ttl_seconds":60}]},"_provenance":{"data":{"source":"kystdatahuset","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/kystdatahuset"},"entities":{"source":"kystdatahuset","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/kystdatahuset","derived_from":"#/data","description":"Normalized projection of data."}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/kystdatahuset/search_ships","source":"https://allemannsdata.com/wiki/api/v1/kilder/kystdatahuset","wiki":"https://allemannsdata.com/wiki/kilder/kystdatahuset/search_ships/","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"}}}