# 1.2 Vessel Search

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/AIS/VesselSearch:
    get:
      summary: 1.2 Vessel Search
      deprecated: false
      description: >-
        ## Description

        The Vessel Search  API performs partial matching searches against
        keywords (MMSI, IMO Number, Vessel Name, Call Sign, etc.) to retrieve
        eligible vessel static records. It returns all historical MMSI records
        linked to a specified IMO Number, or information of all vessels that
        have ever used the given vessel name in history.


        **Note:**  

        Maritime Mobile Service Identity (MMSI) is a 9-digit numeric code used
        in maritime radio communication systems for unique identification of
        individual and group call stations. Unique to each vessel, an MMSI code
        may be changed upon vessel sale; its first three digits indicate the
        country or region of registration.  

        IMO Number (International Maritime Organization Number) is a unique
        7-digit identifier assigned to each vessel by the International Maritime
        Organization, used for global tracking and administration of vessel
        identity, technical specifications and safety records.


        ## Use Cases

        This service is generally integrated into systems or platforms. Returned
        MMSI numbers can act as input parameters for Single Vessel Position
        Query and Vessel Historical Track Query, to retrieve real-time vessel
        position, operational status and historical voyage track.  

        If you have a defined vessel MMSI list, you may skip this service and
        use Single Vessel Position  API or Multi-Vessel Position  API directly
        for fleet monitoring and management.


        ## Request Limits

        An API key must be created before using this service. This API has no
        access frequency limits—unlimited calls are allowed once access
        permission is granted. To apply for or inquire about your access
        permission, please contact our support team: support@elaneglobal.com. 


        ## Endpoint

        | Endpoint | HTTP Method | Remarks |

        | --- | --- | --- |

        |  `https://api.elaneglobal.com/v1/AIS/VesselSearch`  | GET | When using
        partial matching with vessel name or IMO number, multiple results will
        be returned. You can distinguish them by referring to the latest AIS
        report time. Vessels may have their MMSI changed during ownership
        transfers or certain leasing processes. Old MMSI numbers will still be
        retained in records—filter them based on your specific use case. |


        ## Example API Call

        https://api.elaneglobal.com/apicall/v3/VesselSearch?key=1F6D701272402D1E7D8D316CCE519123&keywords=DENEBLEADER&max=5

        Note:

        The key 1F6D701272402D1E7D8D316CCE519123 is the official key of
        elaneglobal.com, bound to the domain api.elaneglobal.com. 

        Users are not authorized to use this key for data access—utilizing it
        will return a status code 14, indicating an error in the source domain.

        To trial the service, please contact our support team:
        support@elaneglobal.com. 
      tags:
        - 1 AIS Dataset
      parameters:
        - name: key
          in: query
          description: Your personal Shipfinderer API key to verify service permissions
          required: true
          example: 1F6D701272402D1E7D8D316CCE519123
          schema:
            type: string
        - name: keywords
          in: query
          description: >-
            The input keywords for vessel query can be vessel name, call sign,
            MMSI, IMO, etc. 

            Matching Rule: MMSI is a 9-digit code; IMO is a 7-digit code.
          required: true
          example: DENEB LEADER
          schema:
            type: string
        - name: max
          in: query
          description: >-
            The maximum number of results to return, with a maximum value of
            100.
          required: false
          example: 5
          schema:
            type: integer
      responses:
        '0':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: API call status code,0 means success
                    title: Status code
                  msg:
                    type: string
                    description: Exception prompt message
                    title: Message
                  total:
                    type: integer
                    title: Total
                    description: Number of query results
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        match_type:
                          type: integer
                          description: |-
                            Type of keyword matching results, matching types: 
                            1=Ship name; 2=Call sign; 3=MMSI; 5=IMO 
                          title: Match Type
                        mmsi:
                          type: integer
                          title: 'MMSI Number '
                          description: 9-digit numeric code of MMSI
                        imo:
                          type: integer
                          title: IMO number
                          description: 7-digit numeric code of IMO
                        call_sign:
                          type: string
                          title: 'Call Sign '
                          description: 'Call Sign '
                        ship_name:
                          type: string
                          title: 'Vessel Name '
                          description: Vessel name
                        data_source:
                          type: integer
                          title: AIS Data Source
                          description: |-
                            0=Terrestrial AIS stations or Shipborne AIS; 
                            1=Satellite AIS
                        last_time:
                          type: integer
                          title: Last Update Time (UTC)
                          description: AIS last update time in Unix timestamp
                      required:
                        - match_type
                        - mmsi
                        - imo
                        - call_sign
                        - ship_name
                        - data_source
                        - last_time
                      x-apifox-orders:
                        - match_type
                        - mmsi
                        - imo
                        - call_sign
                        - ship_name
                        - data_source
                        - last_time
                required:
                  - status
                  - msg
                  - total
                  - data
                x-apifox-orders:
                  - status
                  - msg
                  - total
                  - data
              example:
                status: 0
                msg: ''
                total: 3
                data:
                  - match_type: 1
                    mmsi: 356688000
                    imo: 9738777
                    call_sign: 3EKQ
                    ship_name: DENEB LEADER
                    data_source: 0
                    last_time: 1773728217
                  - match_type: 1
                    mmsi: 346559616
                    imo: 9738777
                    call_sign: 3EKQ
                    ship_name: DENEB LEADER
                    data_source: 0
                    last_time: 1772838361
                  - match_type: 1
                    mmsi: 525007112
                    imo: 0
                    call_sign: ''
                    ship_name: DENEB LEADER
                    data_source: 0
                    last_time: 1765181535
          headers: {}
          x-apifox-name: success
      security: []
      x-apifox-folder: 1 AIS Dataset
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-428749512-run
components:
  schemas: {}
  securitySchemes: {}
servers: []
security: []

```
