{"source":"ais","operation":"get_area_traffic","description":"Snapshot of ship traffic in an area - \"how busy is Oslofjorden right\nnow\". Give a Norwegian place name OR a lat/lon coordinate. Signature: get_area_traffic(place: string, optional, default None; lat: decimal number, decimal degrees (WGS84), optional, default None; lon: decimal number, decimal degrees (WGS84), optional, default None; radius_km: decimal number, kilometres, optional, default 20; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0).","signature":"get_area_traffic(place: string, optional, default None; lat: decimal number, decimal degrees (WGS84), optional, default None; lon: decimal number, decimal degrees (WGS84), optional, default None; radius_km: decimal number, kilometres, optional, default 20; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0)","parameters":[{"name":"place","type":"string","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Norwegian place/area name, e.g. \"Oslofjorden\", \"Stavanger\".","unit":null},{"name":"lat","type":"number","schema":{"anyOf":[{"type":"number"},{"type":"null"}]},"required":false,"default":null,"description":"Latitude in decimal degrees (WGS84). Unit: decimal degrees (WGS84).","unit":"decimal degrees (WGS84)"},{"name":"lon","type":"number","schema":{"anyOf":[{"type":"number"},{"type":"null"}]},"required":false,"default":null,"description":"Longitude in decimal degrees (WGS84). Unit: decimal degrees (WGS84).","unit":"decimal degrees (WGS84)"},{"name":"radius_km","type":"number","schema":{"type":"number"},"required":false,"default":20,"description":"Area radius in km, max 100 (default 20). Unit: kilometres.","unit":"kilometres"},{"name":"limit","type":"integer","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"display_type":"integer","required":false,"default":25,"description":"Maximum list items returned by the gateway (default 25, maximum 100).","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/ais/get_area_traffic?place={place}&lat={lat}&lon={lon}&radius_km=20&limit=25&offset=0","requires_one_of":{"alternatives":[["place"],["lat","lon"]],"exactly_one":false,"description":"Give at least one of: place; lat and lon."},"example_url":"https://allemannsdata.com/wiki/api/v1/kilder/ais/get_area_traffic?place=Oslofjorden","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"area":{"type":"string"},"radius_km":{"type":"number"},"total_vessels":{"type":"integer"},"moving":{"type":"integer"},"stationary":{"type":"integer"},"by_type":{"type":"object","additionalProperties":{"type":"integer"}},"by_nav_status":{"type":"object","additionalProperties":{"type":"integer"}},"busiest_headings":{"type":"object","additionalProperties":{"type":"integer"}}},"additionalProperties":false,"required":["area","radius_km","total_vessels","moving","stationary","by_type","by_nav_status","busiest_headings"]},"response_schema_status":{"status":"declared","codegen_safe":true,"description":"Maintained response contract."},"entity_projection":{"status":"projected","entity_types":["vessel","place"],"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/ais/get_area_traffic/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/ais/get_area_traffic","source":"https://allemannsdata.com/wiki/api/v1/kilder/ais","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"},"output_fields":["area","radius_km","total_vessels","moving","stationary","by_type","by_nav_status","busiest_headings"],"output_fields_truncated":false,"canonical_field_aliases":{},"response_example":{"source":"ais","operation":"get_area_traffic","parameters":{"place":"Oslofjorden","limit":25,"offset":0},"data":{"area":"example value","radius_km":1.0,"total_vessels":1,"moving":1,"stationary":1,"by_type":{"example_key":1},"by_nav_status":{"example_key":1},"busiest_headings":{"example_key":1}},"entities":[],"_meta":{"retrieved_at":"2026-01-15T12:00:00Z","language":"en","content_languages":["en"],"sources":[{"id":"ais","name":"AIS and vessels","description":"Latest known vessel positions, vessel search and historical AIS tracks from BarentsWatch.","publisher":"Kystverket (BarentsWatch)","license":"https://data.norge.no/nlod/en/2.0/","cache_ttl_seconds":300,"documentation":"https://developer.barentswatch.no/docs/AIS/"}]},"_provenance":{"data":{"source":"ais","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/ais"},"entities":{"source":"ais","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/ais","derived_from":"#/data","description":"Normalized projection of data."}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/ais/get_area_traffic","source":"https://allemannsdata.com/wiki/api/v1/kilder/ais","wiki":"https://allemannsdata.com/wiki/kilder/ais/get_area_traffic/","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"}}}
