> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anysite.io/llms.txt
> Use this file to discover all available pages before exploring further.

# /importyeti/companies/partners

> List the trading partners recorded against one business in US ocean import bills of lading, ranked by shipment volume. For a US importer these are its foreign suppliers; for a foreign supplier these are its US customers. Each partner carries its own ImportYeti id, name, address, country, shipments over the whole record and over the last 12 months, weight and TEU totals, the HS codes and goods descriptions moved on that relationship, an HS chapter breakdown, the partner's own largest counterparties, a month-by-month shipment history for the pair, and the UFLPA forced-labour flag.

**Price:** 20 credits

**⚠️ Common errors:** 412: No ImportYeti profile under that id, on either the company or the supplier side



## OpenAPI

````yaml /openapi/company-startup-intel.json post /api/importyeti/companies/partners
openapi: 3.1.0
info:
  title: Any Site API
  description: >+
    Any Site API provides programmatic access to data from LinkedIn, Instagram,
    Twitter, and other platforms.


    ## Authentication


    All API endpoints require an `access-token` header with a valid API token.
    Tokens can be created in the [dashboard](https://app.anysite.io/).


    ## Pricing


    Each endpoint has a credit cost listed in its description. Credits are
    deducted from your token balance per request.

  version: 0.0.1
servers: []
security:
  - AccessToken: []
paths:
  /api/importyeti/companies/partners:
    post:
      tags:
        - /importyeti
      summary: /importyeti/companies/partners
      description: >-
        List the trading partners recorded against one business in US ocean
        import bills of lading, ranked by shipment volume. For a US importer
        these are its foreign suppliers; for a foreign supplier these are its US
        customers. Each partner carries its own ImportYeti id, name, address,
        country, shipments over the whole record and over the last 12 months,
        weight and TEU totals, the HS codes and goods descriptions moved on that
        relationship, an HS chapter breakdown, the partner's own largest
        counterparties, a month-by-month shipment history for the pair, and the
        UFLPA forced-labour flag.


        **Price:** 20 credits


        **⚠️ Common errors:** 412: No ImportYeti profile under that id, on
        either the company or the supplier side
      operationId: __api_importyeti_companies_partners_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportyetiPartnersPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ImportyetiTradePartner'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ImportyetiPartnersPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        company:
          type: string
          minLength: 1
        count:
          type: integer
          maximum: 50
          minimum: 1
      type: object
      required:
        - company
        - count
    ImportyetiTradePartner:
      properties:
        '@type':
          type: string
          default: ImportyetiTradePartner
        name:
          anyOf:
            - type: string
            - type: 'null'
        is_name_withheld:
          anyOf:
            - type: boolean
            - type: 'null'
        id:
          anyOf:
            - type: string
            - type: 'null'
        alias:
          anyOf:
            - type: string
            - type: 'null'
        role:
          anyOf:
            - type: string
            - type: 'null'
        url:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        location:
          anyOf:
            - type: string
            - type: 'null'
        location_url:
          anyOf:
            - type: string
            - type: 'null'
        country:
          anyOf:
            - type: string
            - type: 'null'
        country_code:
          anyOf:
            - type: string
            - type: 'null'
        country_url:
          anyOf:
            - type: string
            - type: 'null'
        total_shipments:
          anyOf:
            - type: integer
            - type: 'null'
        shipments_12m:
          anyOf:
            - type: integer
            - type: 'null'
        total_weight:
          anyOf:
            - type: integer
            - type: 'null'
        total_teu:
          anyOf:
            - type: integer
            - type: 'null'
        hs_codes:
          items:
            type: string
          type: array
          default: []
        hs_chapters:
          items:
            $ref: '#/components/schemas/ImportyetiHsChapterShare'
          type: array
          default: []
        product_description:
          anyOf:
            - type: string
            - type: 'null'
        top_partners:
          items:
            $ref: '#/components/schemas/ImportyetiTopPartner'
          type: array
          default: []
        monthly_shipments:
          items:
            $ref: '#/components/schemas/ImportyetiPartnerMonthlyPoint'
          type: array
          default: []
        is_internal:
          anyOf:
            - type: boolean
            - type: 'null'
        is_uflpa_flagged:
          anyOf:
            - type: boolean
            - type: 'null'
        uflpa_url:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    ImportyetiHsChapterShare:
      properties:
        '@type':
          type: string
          default: ImportyetiHsChapterShare
        chapter:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        shipments:
          anyOf:
            - type: integer
            - type: 'null'
        shipments_share:
          anyOf:
            - type: number
            - type: 'null'
        weight:
          anyOf:
            - type: integer
            - type: 'null'
        weight_share:
          anyOf:
            - type: number
            - type: 'null'
        teu:
          anyOf:
            - type: integer
            - type: 'null'
        teu_share:
          anyOf:
            - type: number
            - type: 'null'
      type: object
      required:
        - chapter
    ImportyetiTopPartner:
      properties:
        '@type':
          type: string
          default: ImportyetiTopPartner
        name:
          type: string
        total_shipments:
          anyOf:
            - type: integer
            - type: 'null'
        shipments_12m:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
      required:
        - name
    ImportyetiPartnerMonthlyPoint:
      properties:
        '@type':
          type: string
          default: ImportyetiPartnerMonthlyPoint
        date:
          type: string
        shipments:
          anyOf:
            - type: integer
            - type: 'null'
        weight:
          anyOf:
            - type: integer
            - type: 'null'
        teu:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
      required:
        - date
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
        input: {}
        ctx:
          type: object
      type: object
      required:
        - loc
        - msg
        - type
  securitySchemes:
    AccessToken:
      type: apiKey
      in: header
      name: access-token
      description: API token from the dashboard

````