Skip to content

feat: add vessel_tags filter to Vessels.search()#570

Merged
alexspeddingvortexa merged 1 commit into
masterfrom
feat/vessel-tags-filter
Jul 7, 2026
Merged

feat: add vessel_tags filter to Vessels.search()#570
alexspeddingvortexa merged 1 commit into
masterfrom
feat/vessel-tags-filter

Conversation

@alexspeddingvortexa

@alexspeddingvortexa alexspeddingvortexa commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

RELATED TICKETS

  • ad-hoc

CHANGELOG

  • Added vessel_tags and vessel_tags_excluded parameters to Vessels.search() to support filtering vessels by tags (e.g. vessel_fso_tag, vessel_decommissioned_tag)
  • Bumped version to 1.0.29

TESTS

  • Added 4 unit tests verifying vessel_tags and vessel_tags_excluded are correctly passed through to the API (single tag, multiple tags, exclusion)

COMMENTS

  • Follows the same pattern used by other endpoints (CargoMovements, VoyagesTimeseries, etc.) for vessel tag filtering

USAGE EXAMPLE

Install from this branch:

pip install git+https://github.com/VorTECHsa/python-sdk.git@feat/vessel-tags-filter

Then use:

from vortexasdk import Vessels
from vortexasdk.api.shared_types import Tag

# Fetch all FSO vessels
vessels = Vessels().search(
    vessel_tags=[Tag(tag="vessel_fso_tag")],
).to_df(columns=["name", "imo", "mmsi", "vessel_class", "tags"])

print(f"Found {len(vessels)} FSO vessels")
print(vessels.to_string())

Or run the included script from a local clone of this branch:

./venv/bin/python scripts/fetch_fso_vessels.py

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings July 7, 2026 10:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds vessel tag filtering support to the Vessels.search() reference endpoint, aligning it with tag-filter patterns used across other endpoints and releasing the change as version 1.0.29.

Changes:

  • Added vessel_tags and vessel_tags_excluded parameters to Vessels.search().
  • Passed these parameters through in the request payload.
  • Added unit tests covering single/multiple tag inclusion and exclusion; bumped SDK version to 1.0.29.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File Description
vortexasdk/version.py Bumps SDK version to 1.0.29.
vortexasdk/endpoints/vessels.py Adds vessel_tags/vessel_tags_excluded parameters and includes them in api_params.
tests/endpoints/test_vessels.py Adds unit tests asserting the new params are passed through to the client call.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread vortexasdk/endpoints/vessels.py Outdated
Comment thread tests/endpoints/test_vessels.py Outdated
Comment thread tests/endpoints/test_vessels.py Outdated
Comment thread tests/endpoints/test_vessels.py Outdated
Comment thread tests/endpoints/test_vessels.py Outdated
@alexspeddingvortexa alexspeddingvortexa force-pushed the feat/vessel-tags-filter branch 3 times, most recently from e7ed8c5 to f8c1b14 Compare July 7, 2026 11:13

@kdalkas kdalkas left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

…rch()

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@alexspeddingvortexa alexspeddingvortexa force-pushed the feat/vessel-tags-filter branch from f8c1b14 to 4f5115b Compare July 7, 2026 12:48
@alexspeddingvortexa alexspeddingvortexa merged commit 7732131 into master Jul 7, 2026
11 of 12 checks passed
@alexspeddingvortexa alexspeddingvortexa deleted the feat/vessel-tags-filter branch July 7, 2026 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants