gateway.apiosk.com · options

API call to shipment-api

Call it in 30 seconds

// npm i x402-fetch viem
import { wrapFetchWithPayment } from "x402-fetch";
import { createWalletClient, http } from "viem";
import { privateKeyToAccount } from "viem/accounts";
import { base } from "viem/chains";

const account = privateKeyToAccount(process.env.PRIVATE_KEY); // funds USDC on Base
const wallet = createWalletClient({ account, chain: base, transport: http() });
const fetchWithPay = wrapFetchWithPayment(fetch, wallet);

// Pays the $0.15 USDC automatically on the 402, then returns the real response:
const res = await fetchWithPay("https://gateway.apiosk.com/shipment-api/shipments/options", { method: "GET" });
console.log(await res.json());

# pip install x402 eth-account httpx
import os, asyncio
from eth_account import Account
from x402.clients.httpx import x402HttpxClient

account = Account.from_key(os.environ["PRIVATE_KEY"])  # funds USDC on Base

async def main():
    async with x402HttpxClient(account=account) as client:
        # x402 handles the 402 -> pay ($0.15 USDC) -> retry automatically
        r = await client.get("https://gateway.apiosk.com/shipment-api/shipments/options")
        print((await r.aread()).decode())

asyncio.run(main())

# 1) An unpaid request returns HTTP 402 with the exact payment terms:
curl -i "https://gateway.apiosk.com/shipment-api/shipments/options?description=Parameters accept both snake_case and camelCase keys.&properties={'carrier': {'description': 'Filter to a single carrier slug, e.g. dpd, postnl, dhl (optional).', 'example': 'dpd', 'type': 'string'}, 'currency': {'default': 'EUR', 'description': 'Label currency for the returned prices (optional).', 'type': 'string'}, 'from_country': {'description': 'Origin country, 2-letter ISO code.', 'example': 'NL', 'pattern': '^[A-Za-z]{2}$', 'type': 'string'}, 'from_postal_code': {'description': 'Origin postal code (optional, improves accuracy).', 'example': '1000AA', 'type': 'string'}, 'height': {'description': 'Parcel height in centimetres (optional).', 'exclusiveMinimum': 0, 'type': 'number'}, 'length': {'description': 'Parcel length in centimetres (optional).', 'exclusiveMinimum': 0, 'type': 'number'}, 'to_country': {'description': 'Destination country, 2-letter ISO code.', 'example': 'DE', 'pattern': '^[A-Za-z]{2}$', 'type': 'string'}, 'to_postal_code': {'description': 'Destination postal code (optional).', 'example': '10115', 'type': 'string'}, 'weight': {'description': 'Parcel weight as a positive number.', 'example': 2.5, 'exclusiveMinimum': 0, 'type': 'number'}, 'weight_unit': {'default': 'kilogram', 'description': 'Unit for weight.', 'enum': ['kilogram', 'gram'], 'type': 'string'}, 'width': {'description': 'Parcel width in centimetres (optional).', 'exclusiveMinimum': 0, 'type': 'number'}}&required=['from_country', 'to_country', 'weight']&type=object"

# 2) Paying + retrying requires an x402 client that can sign the USDC
#    authorization (curl alone cannot). See the JS / Python tabs below.

New to x402? Read the 5-minute quickstart →