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 Distribution

shipinfo_sdk-0.1.1.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

Details for the file shipinfo_sdk-0.1.1.tar.gz.

File metadata

  • Download URL: shipinfo_sdk-0.1.1.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.3

File hashes

Hashes for shipinfo_sdk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c6f914f38b8fd3add32d99c61faf594b7997558a0e80c237afa239b5e043cc9d
MD5 ab4231c24d18ed5bf645bf37343a7fb6
BLAKE2b-256 aa05768e49302e959e7fc84c16a27ae34bb3a2b0af2dc5ec6907d7f89ebdd6b7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shipinfo_sdk-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c812a4729821e516842807f0eb84a8374524f67a9bbfe94d9a1da7a25be711f0
MD5 edb576592de927fe6bd4476993b6fd1e
BLAKE2b-256 4c81b2a8918cfc922dec6d645cff71e8e4cea766a1c6fa33dea31d047631e701

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