> For the complete documentation index, see [llms.txt](https://docs.raalabs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.raalabs.io/reference/api-reference/metadata.md).

# Metadata

The Metadata endpoint provides detailed metadata about time series tags. This includes information such as the human-readable name of the signal, description, units of measure, data source, scaling factor, valid range, and mappings to other naming domains. Use this endpoint to understand what a particular time series represents.

## GET /metadata/id/{ids}

> Get metadata from the id domain

```json
{"openapi":"3.0.0","info":{"title":"Raa Labs Time Series API","version":"2025-10-31"},"tags":[{"description":"The Metadata endpoint provides detailed metadata about time series tags. This includes information such as the human-readable name of the signal, description, units of measure, data source, scaling factor, valid range, and mappings to other naming domains. Use this endpoint to understand what a particular time series represents.","name":"Metadata"}],"servers":[{"description":"API Server","url":"http://localhost:8080","variables":{}}],"security":[{"authorization":[]}],"components":{"securitySchemes":{"authorization":{"scheme":"bearer","type":"http"}},"schemas":{"IDMetadata":{"allOf":[{"$ref":"#/components/schemas/CommonMetadata"}],"description":"Metadata from the Raalabs domain","title":"IDMetadata","type":"object"},"CommonMetadata":{"description":"Properties common to all Metadata types","properties":{"description":{"type":"string"},"mapsTo":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"rangeHigh":{"type":"integer"},"rangeLow":{"type":"integer"},"scale":{"type":"number"},"source":{"type":"string"},"timeSeriesId":{"format":"uuid","type":"string"},"uom":{"type":"string"},"vesselImo":{"type":"string"},"vesselName":{"type":"string"}},"title":"CommonMetadata","type":"object"},"BadRequestResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"BadRequestResponse","type":"object"},"UnauthorizedErrorResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"UnauthorizedErrorResponse","type":"object"},"NotFoundErrorresponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"NotFoundErrorresponse","type":"object"},"InternalServerErrorResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"InternalServerErrorResponse","type":"object"}}},"paths":{"/metadata/id/{ids}":{"get":{"callbacks":{},"deprecated":false,"operationId":"get_metadata_id","parameters":[{"description":"A comma-separated list of one or more GUIDs","in":"path","name":"ids","required":false,"schema":{"type":"string"}},{"description":"Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.","in":"query","name":"format","schema":{"default":"json","enum":["json"],"type":"string"}},{"description":"When true, includes human-readable names for the corresponding VIS path elements in vis-3-8a domainIds. If false (or omitted), regular domainIds are returned.","in":"query","name":"verbose","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDMetadata"}}},"description":"Response from the route","headers":{"api-version":{"description":"API version","required":true,"schema":{"type":"string"},"style":"simple"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorresponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Get metadata from the id domain","tags":["Metadata"]}}}}
```

## Get metadata from the jsmea domain

> Get metadata from the jsmea domain

```json
{"openapi":"3.0.0","info":{"title":"Raa Labs Time Series API","version":"2025-10-31"},"tags":[{"description":"The Metadata endpoint provides detailed metadata about time series tags. This includes information such as the human-readable name of the signal, description, units of measure, data source, scaling factor, valid range, and mappings to other naming domains. Use this endpoint to understand what a particular time series represents.","name":"Metadata"}],"servers":[{"description":"API Server","url":"http://localhost:8080","variables":{}}],"security":[{"authorization":[]}],"components":{"securitySchemes":{"authorization":{"scheme":"bearer","type":"http"}},"schemas":{"JsmeaMetadata":{"allOf":[{"$ref":"#/components/schemas/CommonMetadata"}],"title":"JsmeaMetadata","type":"object"},"CommonMetadata":{"description":"Properties common to all Metadata types","properties":{"description":{"type":"string"},"mapsTo":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"rangeHigh":{"type":"integer"},"rangeLow":{"type":"integer"},"scale":{"type":"number"},"source":{"type":"string"},"timeSeriesId":{"format":"uuid","type":"string"},"uom":{"type":"string"},"vesselImo":{"type":"string"},"vesselName":{"type":"string"}},"title":"CommonMetadata","type":"object"},"BadRequestResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"BadRequestResponse","type":"object"},"UnauthorizedErrorResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"UnauthorizedErrorResponse","type":"object"},"NotFoundErrorresponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"NotFoundErrorresponse","type":"object"},"InternalServerErrorResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"InternalServerErrorResponse","type":"object"}}},"paths":{"/metadata/jsmea/{imo_number}/{naming_rule}/{category}/{sub_category}/{content}/{position}/{item}/{modifier}":{"get":{"callbacks":{},"deprecated":false,"description":"Get metadata from the jsmea domain","operationId":"get_metadata_jsmea","parameters":[{"description":"The IMO number of the vessel to retrieve from","in":"path","name":"imo_number","required":false,"schema":{"type":"string"}},{"description":"The naming rule to use for retrieval","in":"path","name":"naming_rule","required":false,"schema":{"type":"string"}},{"description":"The category to retrieve from","in":"path","name":"category","required":false,"schema":{"type":"string"}},{"description":"The sub category to retrieve from","in":"path","name":"sub_category","required":false,"schema":{"type":"string"}},{"description":"The content to retrieve from","in":"path","name":"content","required":false,"schema":{"type":"string"}},{"description":"The position to retrieve from","in":"path","name":"position","required":false,"schema":{"type":"string"}},{"description":"The item to retrieve from","in":"path","name":"item","required":false,"schema":{"type":"string"}},{"description":"The modifier to retrieve from","in":"path","name":"modifier","required":false,"schema":{"type":"string"}},{"description":"Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.","in":"query","name":"format","schema":{"default":"json","enum":["json"],"type":"string"}},{"description":"When true, includes human-readable names for the corresponding VIS path elements in vis-3-8a domainIds. If false (or omitted), regular domainIds are returned.","in":"query","name":"verbose","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsmeaMetadata"}}},"description":"Response from the route","headers":{"api-version":{"description":"API version","required":true,"schema":{"type":"string"},"style":"simple"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorresponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Get metadata from the jsmea domain","tags":["Metadata"]}}}}
```

## GET /metadata/raalabs/{imo\_number}/{tag\_name}

> Get metadata from the raalabs domain

```json
{"openapi":"3.0.0","info":{"title":"Raa Labs Time Series API","version":"2025-10-31"},"tags":[{"description":"The Metadata endpoint provides detailed metadata about time series tags. This includes information such as the human-readable name of the signal, description, units of measure, data source, scaling factor, valid range, and mappings to other naming domains. Use this endpoint to understand what a particular time series represents.","name":"Metadata"}],"servers":[{"description":"API Server","url":"http://localhost:8080","variables":{}}],"security":[{"authorization":[]}],"components":{"securitySchemes":{"authorization":{"scheme":"bearer","type":"http"}},"schemas":{"RaalabsMetadata":{"allOf":[{"$ref":"#/components/schemas/CommonMetadata"}],"description":"Metadata from the Raalabs domain","title":"RaalabsMetadata","type":"object"},"CommonMetadata":{"description":"Properties common to all Metadata types","properties":{"description":{"type":"string"},"mapsTo":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"rangeHigh":{"type":"integer"},"rangeLow":{"type":"integer"},"scale":{"type":"number"},"source":{"type":"string"},"timeSeriesId":{"format":"uuid","type":"string"},"uom":{"type":"string"},"vesselImo":{"type":"string"},"vesselName":{"type":"string"}},"title":"CommonMetadata","type":"object"},"BadRequestResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"BadRequestResponse","type":"object"},"UnauthorizedErrorResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"UnauthorizedErrorResponse","type":"object"},"NotFoundErrorresponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"NotFoundErrorresponse","type":"object"},"InternalServerErrorResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"InternalServerErrorResponse","type":"object"}}},"paths":{"/metadata/raalabs/{imo_number}/{tag_name}":{"get":{"callbacks":{},"deprecated":false,"operationId":"get_metadata_raalabs","parameters":[{"description":"The IMO number of the vessel","in":"path","name":"imo_number","required":false,"schema":{"type":"string"}},{"description":"Short descriptive tag name","in":"path","name":"tag_name","required":false,"schema":{"type":"string"}},{"description":"Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.","in":"query","name":"format","schema":{"default":"json","enum":["json"],"type":"string"}},{"description":"When true, includes human-readable names for the corresponding VIS path elements in vis-3-8a domainIds. If false (or omitted), regular domainIds are returned.","in":"query","name":"verbose","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RaalabsMetadata"}}},"description":"Response from the route","headers":{"api-version":{"description":"API version","required":true,"schema":{"type":"string"},"style":"simple"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorresponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Get metadata from the raalabs domain","tags":["Metadata"]}}}}
```

## GET /metadata/vis-3-8a/{imo\_number}/{primary\_item\_vis\_path}/sec/{secondary\_item\_vis\_path}/meta/{metadata}

> Get metadata from the vis-3-8a domain

```json
{"openapi":"3.0.0","info":{"title":"Raa Labs Time Series API","version":"2025-10-31"},"tags":[{"description":"The Metadata endpoint provides detailed metadata about time series tags. This includes information such as the human-readable name of the signal, description, units of measure, data source, scaling factor, valid range, and mappings to other naming domains. Use this endpoint to understand what a particular time series represents.","name":"Metadata"}],"servers":[{"description":"API Server","url":"http://localhost:8080","variables":{}}],"security":[{"authorization":[]}],"components":{"securitySchemes":{"authorization":{"scheme":"bearer","type":"http"}},"schemas":{"Vis38Metadata":{"items":{"properties":{"id":{"format":"uuid","type":"string"},"imo":{"type":"integer"},"vis_path":{"type":"string"}},"type":"object"},"title":"Vis38Metadata","type":"array"},"BadRequestResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"BadRequestResponse","type":"object"},"UnauthorizedErrorResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"UnauthorizedErrorResponse","type":"object"},"NotFoundErrorresponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"NotFoundErrorresponse","type":"object"},"InternalServerErrorResponse":{"properties":{"error":{"description":"Error message","type":"string"}},"title":"InternalServerErrorResponse","type":"object"}}},"paths":{"/metadata/vis-3-8a/{imo_number}/{primary_item_vis_path}/sec/{secondary_item_vis_path}/meta/{metadata}":{"get":{"callbacks":{},"deprecated":false,"operationId":"get_metadata_vis38","parameters":[{"description":"The IMO number of the vessel to retrieve from","in":"path","name":"imo_number","required":false,"schema":{"type":"string"}},{"description":"Primary item VIS path","in":"path","name":"primary_item_vis_path","required":false,"schema":{"type":"string"}},{"description":"Secondary item VIS path","in":"path","name":"secondary_item_vis_path","required":false,"schema":{"type":"string"}},{"description":"Metadata","in":"path","name":"metadata","required":false,"schema":{"type":"string"}},{"description":"Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.","in":"query","name":"format","schema":{"default":"json","enum":["json"],"type":"string"}},{"description":"When true, includes human-readable names for the corresponding VIS path elements in vis-3-8a domainIds. If false (or omitted), regular domainIds are returned.","in":"query","name":"verbose","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vis38Metadata"}}},"description":"Response from the route","headers":{"api-version":{"description":"API version","required":true,"schema":{"type":"string"},"style":"simple"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorresponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Get metadata from the vis-3-8a domain","tags":["Metadata"]}}}}
```