Skip to main content

ShipInfo maritime analytics SDK for AI agents

Project description

shipinfo-sdk

Python SDK for ShipInfo agent-native API.

Install

pip install shipinfo-sdk

Quickstart

from shipinfo_sdk import ShipInfoClient

client = ShipInfoClient(
    base_url="https://shipinfo.net/topos/api",
    api_key=None,
    agent_headers={
        "name": "demo-agent",
        "vendor": "example-inc",
        "contact": "https://example.com/agent",
        "session": "sess-001",
    },
)

caps = client.capabilities()
print(caps.get("status"))

API

  • capabilities()
  • policy()
  • quality()
  • billing_pricing()
  • billing_x402_requirements(resource="/topos/api/v1/vessels/lookup")
  • billing_x402_verify(resource, payment, payment_signature=None)
  • vessel_lookup(vessel_id)
  • port_congestion(port_id, range=None, vessel_type=None)
  • sts_events(**kwargs)
  • route_stress_index(zone_key=None, range=None)
  • get_paginated(path, params=None, limit_pages=10, cursor_field="next_cursor", items_field=None)

x402 Notes

  • On HTTP 402, ShipInfoHttpError includes:
    • status_code
    • retryable
    • response_headers
    • payment_required (parsed from PAYMENT-REQUIRED/payment-required header if available)
  • For proof-based verify flow use payment_signature; SDK sends PAYMENT-SIGNATURE header.

Fair Value Rule

Paid calls follow payer autonomy semantics: agent_self_assessed_fair_value, paid_interactions_only.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shipinfo_sdk-0.1.0-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file shipinfo_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: shipinfo_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.3

File hashes

Hashes for shipinfo_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6a1822c4c7b7339837196615e480d76b23ff336fefca100c2fb5d1a560ffc84f
MD5 2579f2e887776bb4940d6aacacf4acec
BLAKE2b-256 2e8d3b995effa82edc7d88c54b7279b5403fbd7eb61c7c09058ef34ab93cc72d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page