economy

Get a US importer's suppliers and shipments

Returns what a US company imports by sea, from public US customs bill-of-lading records. Response is { company, top_suppliers, hs_codes, recent_shipments, matches, selection }. company carries the importer's name, country, address, website, lifetime and last-12-month shipment counts, first and most recent shipment dates (ISO), supplier count and the other names it files under. top_suppliers lists up to 25 overseas suppliers by shipment count, each with country, lifetime and 12-month shipments, total weight in kilograms and the HS headings it ships; a supplier name (and a shipment's supplier) is null where the manifests do not name the shipper, and those counts are kept. hs_codes lists up to 25 four-digit HS headings by shipment count, each with its chapter. recent_shipments lists the latest bills of lading, newest first: date, bill number, supplier, supplier country, product description, weight in kilograms, container count, quantity and unit, and the ocean route (for example 'Asia, Pacific'). hs_code on a shipment is filled only when the shipper wrote a tariff number into the manifest text, which is uncommon; use hs_codes for the product mix. Ports of loading and discharge are not published per shipment. A brand often files under several names (a parent, a US subsidiary, a fulfilment site), so the answer is chosen in three steps and selection says which one applied. name_match: the filer whose name equals yours, ignoring spacing and endings such as Inc, LLC and USA, with the most shipments ('Nike' returns 'Nike Usa' rather than a small entity called 'Nike', and 'Walmart' returns 'Wal Mart'). partial_match: otherwise, the filer with the most shipments whose name contains yours as whole words ('Peloton' returns 'Peloton Interactive'). largest_search_hit: otherwise, the candidate with the most shipments. Every candidate is listed in matches with its shipment count and last shipment date, and the one answered has selected: true; to target a different one, call again with its exact name. Only US imports by ocean freight are covered, so air freight, exports and non-US trade are absent, and some importers have their manifests withheld by request. A name with no US import records returns 404 and costs 0 credits. A billed call typically takes 8 to 12s and can reach about 25s, so set a client timeout of at least 45s. Exact repeats are served from a 24-hour cache at 0 credits.

get/economy/imports

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/economy/imports
  • Auth: API key in header x-api-key

Query parameters

companystring required

The US importer's company name, as a brand ('Nike') or as it appears on shipping documents ('Nike Usa'). Endings such as Inc, LLC and USA are ignored when matching. 1 to 200 characters.

limitinteger

How many recent shipments to return, newest first, from 1 to 50. Defaults to 25. The price is the same for any value.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "economy",
  "endpoint": "/v1/economy/imports",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.