{"source":"fiskeridir","operation":"search_vessels","description":"Search Norway's register of active fishing vessels. Signature: search_vessels(query: string, optional, default None; name: string, optional, default None; registration_mark: string, optional, default None; radio_call_sign: string, optional, default None; municipality_code: string, optional, default None; length_gte: decimal number, optional, default None; length_lte: decimal number, optional, default None; sort_by: one of: ID, NAME, REGISTRATIONMARK, RADIOCALLSIGN, optional, default 'ID'; sort_asc: yes/no, optional, default False; limit: integer, items, optional, default 20; offset: integer, items, optional, default 0).","signature":"search_vessels(query: string, optional, default None; name: string, optional, default None; registration_mark: string, optional, default None; radio_call_sign: string, optional, default None; municipality_code: string, optional, default None; length_gte: decimal number, optional, default None; length_lte: decimal number, optional, default None; sort_by: one of: ID, NAME, REGISTRATIONMARK, RADIOCALLSIGN, optional, default 'ID'; sort_asc: yes/no, optional, default False; limit: integer, items, optional, default 20; offset: integer, items, optional, default 0)","parameters":[{"name":"query","type":"string","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Free-text search across several fields (name, marks, call sign).","unit":null},{"name":"name","type":"string","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Filter by vessel name.","unit":null},{"name":"registration_mark","type":"string","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Filter by registration mark, e.g. \"M 0017K\".","unit":null},{"name":"radio_call_sign","type":"string","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Filter by radio call sign, e.g. \"LH6853\".","unit":null},{"name":"municipality_code","type":"string","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Filter by the vessel's home municipality code.","unit":null},{"name":"length_gte","type":"number","schema":{"anyOf":[{"type":"number"},{"type":"null"}]},"required":false,"default":null,"description":"Only vessels at least this long, in metres.","unit":null},{"name":"length_lte","type":"number","schema":{"anyOf":[{"type":"number"},{"type":"null"}]},"required":false,"default":null,"description":"Only vessels at most this long, in metres.","unit":null},{"name":"sort_by","type":"string","schema":{"enum":["ID","NAME","REGISTRATIONMARK","RADIOCALLSIGN"],"type":"string"},"required":false,"default":"ID","description":"Field to sort on: ID, NAME, REGISTRATIONMARK or RADIOCALLSIGN.","unit":null},{"name":"sort_asc","type":"boolean","schema":{"type":"boolean"},"required":false,"default":false,"description":"Sort ascending instead of descending.","unit":null},{"name":"limit","type":"integer","schema":{"type":"integer"},"required":false,"default":20,"description":"Max vessels 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/fiskeridir/search_vessels?query={query}&name={name}&registration_mark={registration_mark}&radio_call_sign={radio_call_sign}&municipality_code={municipality_code}&length_gte={length_gte}&length_lte={length_lte}&sort_by=ID&sort_asc=false&limit=20&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"total":{"type":"integer"},"returned":{"type":"integer"},"vessels":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"]},"name":{"type":["string","null"]},"registrationMark":{"type":["string","null"]},"radioCallSign":{"type":["string","null"]},"imoNumber":{"type":["string","integer","null"]},"municipalityCode":{"type":["string","null"]},"tonnageType":{"type":["string","null"]},"tonnage":{"type":["number","null"]},"width":{"type":["number","null"]},"length":{"type":["number","null"]},"enginePower":{"type":["number","null"]},"engineBuildYear":{"type":["integer","null"]},"buildYear":{"type":["integer","null"]},"measureDate":{"type":["string","null"],"format":"date"},"registrationDate":{"type":["string","null"],"format":"date"},"owners":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"]},"entityType":{"type":["string","null"]},"name":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"city":{"type":["string","null"]}}}}},"required":["id"]}}},"additionalProperties":false,"required":["total","returned","vessels"]},"response_schema_status":{"status":"declared","codegen_safe":true,"description":"Maintained response contract."},"entity_projection":{"status":"projected","entity_types":["fishing_vessel"],"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/fiskeridir/search_vessels/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/fiskeridir/search_vessels","source":"https://allemannsdata.com/wiki/api/v1/kilder/fiskeridir","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"},"output_fields":["total","returned","vessels","vessels[].id","vessels[].name","vessels[].registrationMark","vessels[].radioCallSign","vessels[].imoNumber","vessels[].municipalityCode","vessels[].tonnageType","vessels[].tonnage","vessels[].width","vessels[].length","vessels[].enginePower","vessels[].engineBuildYear","vessels[].buildYear","vessels[].measureDate","vessels[].registrationDate","vessels[].owners","vessels[].owners[].id","vessels[].owners[].entityType","vessels[].owners[].name","vessels[].owners[].postalCode","vessels[].owners[].city"],"output_fields_truncated":false,"canonical_field_aliases":{"identifier":["vessels[].id","vessels[].owners[].id"],"name":["vessels[].name","vessels[].owners[].name"]},"response_example":{"source":"fiskeridir","operation":"search_vessels","parameters":{"query":"example value","name":"Example","registration_mark":"example value","radio_call_sign":"example value","municipality_code":"example value","length_gte":1.0,"length_lte":1.0,"sort_by":"ID","sort_asc":false,"limit":20},"data":{"total":1,"returned":1,"vessels":[{"id":"example-id","name":"Example","registrationMark":"example value","radioCallSign":"example value","imoNumber":"example value","municipalityCode":"example value","tonnageType":"example value","tonnage":1.0,"width":1.0,"length":1.0,"enginePower":1.0,"engineBuildYear":1,"buildYear":1,"measureDate":"2026-01-15","registrationDate":"2026-01-15","owners":[{"id":"example-id","entityType":"example value","name":"Example","postalCode":"example value","city":"example value"}]}]},"entities":[],"_meta":{"retrieved_at":"2026-01-15T12:00:00Z","language":"en","content_languages":["en"],"sources":[{"id":"fiskeridir","name":"Fiskeridirektoratet","description":"Norway's official register of active fishing vessels: marks, dimensions, engine, build data and owners, plus yearly catch, fisher, permit and aquaculture statistics from the statistics bank.","cache_ttl_seconds":300,"documentation":"https://api.fiskeridir.no/vessel-api/swagger-ui/","rate_limit":"The statistics bank allows 10 calls per 10 seconds; the integration paces itself and caches the table list for a day."}]},"_provenance":{"data":{"source":"fiskeridir","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/fiskeridir"},"entities":{"source":"fiskeridir","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/fiskeridir","derived_from":"#/data","description":"Normalized projection of data."}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/fiskeridir/search_vessels","source":"https://allemannsdata.com/wiki/api/v1/kilder/fiskeridir","wiki":"https://allemannsdata.com/wiki/kilder/fiskeridir/search_vessels/","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"}}}