Volos

Volos · Actions GPT

Trade Leads

The Trade Leads API provides contract opportunities for U.S. businesses selling their products and services overseas. We currently provide trade leads from the United Kingdom.

  • GET /trade_leads/v1/searchThe Trade Leads API provides contract opportunities for U.S. businesses selling their products and services overseas. We currently provide trade leads from the United Kingdom.
  • GET /trade_events/v1/searchThe Trade Events API provides data on events for U.S. businesses interested in selling their products and services overseas. These events include industry conferences, webinars, lectures, and trade missions organized by ITA and other trade agencies.
  • GET /de_minimis/v1/searchThe De Minimis API provides data about the De Minimis amount and the Value Added Tax (VAT) amount that products may be subject to when exported to foreign countries. De Minimis is the threshold for a product's value below which no duty or tariff is charged.
  • GET /business_service_providers/v1/searchThe Business Service Providers (BSP) API is a directory of U.S. and foreign-based businesses providing services that many small and medium sized exporters require to succeed in foreign markets. Businesses can sign up to be a Service Provider on www.trade.gov/business-service-provider.
Schéma original API
{
  "openapi": "3.0.1",
  "info": {
    "title": "Trade Leads",
    "description": "The Trade Leads API provides contract opportunities for U.S. businesses selling their products and services overseas. We currently provide trade leads from the United Kingdom.",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://data.trade.gov"
    }
  ],
  "paths": {
    "/trade_leads/v1/search": {
      "get": {
        "operationId": "getTradeLeads",
        "summary": "The Trade Leads API provides contract opportunities for U.S. businesses selling their products and services overseas. We currently provide trade leads from the United Kingdom.",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request- possibly due to incorrect format"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": false,
            "description": "The keyword(s) to search for in the trade leads",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for keyword 'bananas'",
                "value": "bananas"
              }
            }
          },
          {
            "name": "country_codes",
            "in": "query",
            "required": false,
            "description": "The two letter country code to filter the trade leads by country",
            "schema": {
              "type": "string",
              "enum": [
                "UK"
              ]
            },
            "examples": {
              "example1": {
                "summary": "searching for trade leads in United Kingdom",
                "value": "UK"
              }
            }
          },
          {
            "name": "tender_start_date_range[from]",
            "in": "query",
            "required": false,
            "description": "The start date of the tender date range in 'YYYY-MM-DD' format",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for trade leads with tender date after 2019-01-01",
                "value": "2019-01-01"
              }
            }
          },
          {
            "name": "tender_start_date_range[to]",
            "in": "query",
            "required": false,
            "description": "The end date of the tender date range in 'YYYY-MM-DD' format",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for trade leads with tender date before 2019-01-01",
                "value": "2019-01-01"
              }
            }
          },
          {
            "name": "contract_start_date_range[from]",
            "in": "query",
            "required": false,
            "description": "The start date of the contract date range in 'YYYY-MM-DD' format",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for trade leads with contract date after 2019-01-01",
                "value": "2019-01-01"
              }
            }
          },
          {
            "name": "contract_start_date_range[to]",
            "in": "query",
            "required": false,
            "description": "The end date of the contract date range in 'YYYY-MM-DD' format",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for trade leads with contract date before 2019-01-01",
                "value": "2019-01-01"
              }
            }
          },
          {
            "name": "size",
            "in": "query",
            "required": false,
            "description": "The number of trade leads to return. Default is 10.",
            "schema": {
              "type": "integer"
            },
            "examples": {
              "example1": {
                "summary": "searching for 10 trade leads",
                "value": 10
              }
            }
          }
        ]
      }
    },
    "/trade_events/v1/search": {
      "get": {
        "operationId": "getTradeEvents",
        "summary": "The Trade Events API provides data on events for U.S. businesses interested in selling their products and services overseas. These events include industry conferences, webinars, lectures, and trade missions organized by ITA and other trade agencies.",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request- possibly due to incorrect HS code format"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "parameters": [
          {
            "name": "sources",
            "in": "query",
            "required": false,
            "description": "Searched for trade event sources by comma delimited country names.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for trade leads from the US",
                "value": "United States"
              },
              "example2": {
                "summary": "searching trade leads from the US and Mexico.",
                "value": "United States,Mexico"
              }
            }
          },
          {
            "name": "countries",
            "in": "query",
            "required": false,
            "description": "Searched for trade event countries by comma delimited country names.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for trade events in the US",
                "value": "United States"
              },
              "example2": {
                "summary": "searching trade leads in the US and Mexico.",
                "value": "United States,Mexico"
              }
            }
          },
          {
            "name": "industries",
            "in": "query",
            "required": false,
            "description": "Searched for trade event industries by comma delimited industry names.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for trade events in the industry of textiles and apparel",
                "value": "Textile, Apparel, & Sporting Goods"
              },
              "example2": {
                "summary": "searching trade events in the industry of computers and peripherals.",
                "value": "Computers/Peripherals"
              }
            }
          },
          {
            "name": "states",
            "in": "query",
            "required": false,
            "description": "Searched for trade event states by comma delimited US state abbreviations.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for trade events in the state of California",
                "value": "California"
              },
              "example2": {
                "summary": "searching trade events in the state of California and Texas.",
                "value": "California,Texas"
              }
            }
          },
          {
            "name": "q",
            "in": "query",
            "required": false,
            "description": "The keyword(s) to search for in the trade leads",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for keyword 'bananas'",
                "value": "bananas"
              }
            }
          }
        ]
      }
    },
    "/de_minimis/v1/search": {
      "get": {
        "operationId": "getDeMinimis",
        "summary": "The De Minimis API provides data about the De Minimis amount and the Value Added Tax (VAT) amount that products may be subject to when exported to foreign countries. De Minimis is the threshold for a product's value below which no duty or tariff is charged.",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request- possibly due to incorrect HS code format"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "parameters": [
          {
            "name": "country_codes",
            "in": "query",
            "required": false,
            "description": "The two letter country code to find the de minimis value of that country or list of countries delimited by commas.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for de minimis value in Mexico",
                "value": "MX"
              },
              "example2": {
                "summary": "searching for de minimis value in Greenland and Canada",
                "value": "CA,GL"
              }
            }
          }
        ]
      }
    },
    "/business_service_providers/v1/search": {
      "get": {
        "operationId": "getBusinessServiceProviders",
        "summary": "The Business Service Providers (BSP) API is a directory of U.S. and foreign-based businesses providing services that many small and medium sized exporters require to succeed in foreign markets. Businesses can sign up to be a Service Provider on www.trade.gov/business-service-provider.",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request- possibly due to incorrect HS code format"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": false,
            "description": "The keyword(s) to search for business service providers",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "searching for keyword 'bananas'",
                "value": "bananas"
              }
            }
          }
        ]
      }
    }
  }
}

Census International Trade Data API

API for accessing Harmonized System (HS) export data by year and country code

  • GET /hs/Get HS export data by date, optionally by country
Schéma original API
{
  "openapi": "3.0.0",
  "info": {
    "title": "Census International Trade Data API",
    "version": "1.0.0",
    "description": "API for accessing Harmonized System (HS) export data by year and country code"
  },
  "servers": [
    {
      "url": "https://api.census.gov/data/timeseries/intltrade/exports"
    }
  ],
  "paths": {
    "/hs/": {
      "get": {
        "operationId": "getHSExportHistoryData",
        "summary": "Get HS export data by date, optionally by country",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request- possibly due to incorrect HS code format"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "parameters": [
          {
            "name": "get",
            "in": "query",
            "required": true,
            "description": "The names of the parameters of desired data and to be returned in response, separated by commas.",
            "schema": {
              "type": "string",
              "enum": [
                "CTY_CODE,ALL_VAL_MO,ALL_VAL_YR,E_COMMODITY, E_COMMODITY_SDESC, E_COMMODITY_LDESC",
                "CTY_CODE,ALL_VAL_MO,E_COMMODITY, E_COMMODITY_SDESC, E_COMMODITY_LDESC",
                "CTY_CODE,ALL_VAL_YR,E_COMMODITY, E_COMMODITY_SDESC, E_COMMODITY_LDESC",
                "ALL_VAL_MO,ALL_VAL_YR,E_COMMODITY, E_COMMODITY_SDESC, E_COMMODITY_LDESC",
                "ALL_VAL_MO,E_COMMODITY, E_COMMODITY_SDESC, E_COMMODITY_LDESC",
                "ALL_VAL_YR,E_COMMODITY, E_COMMODITY_SDESC, E_COMMODITY_LDESC",
                "CTY_CODE,E_COMMODITY, E_COMMODITY_SDESC, E_COMMODITY_LDESC",
                "ALL_VAL_MO,ALL_VAL_YR",
                "ALL_VAL_MO",
                "ALL_VAL_YR",
                "CTY_CODE",
                "E_COMMODITY, E_COMMODITY_SDESC, E_COMMODITY_LDESC",
                "CTY_CODE,ALL_VAL_MO,ALL_VAL_YR",
                "CTY_CODE,ALL_VAL_MO",
                "CTY_CODE,ALL_VAL_YR"
              ]
            },
            "examples": {
              "example1": {
                "summary": "Returning city codes, city names, and total values for each month and each year.",
                "value": "CTY_CODE,CTY_NAME,ALL_VAL_MO,ALL_VAL_YR"
              },
              "example2": {
                "summary": "Returning desired information of the HS code, short description, long description, monthly value, and yearly value",
                "value": "E_COMMODITY,E_COMMODITY_SDESC,E_COMMODITY_LDESC,ALL_VAL_MO,ALL_VAL_YR"
              }
            }
          },
          {
            "name": "time",
            "in": "query",
            "required": true,
            "description": "Specify the time period for the export data in 'YYYY-MM' format. This cannot exclude the month. If a time range is needed, use format 'from+YYYY-MM+to+YYYY-MM'",
            "schema": {
              "type": "string"
            },
            "examples": {
              "example1": {
                "summary": "Example for January 2013",
                "value": "2013-01"
              },
              "example2": {
                "summary": "Example for the whole year of 2014",
                "value": "from+2013-01+to+2013-12"
              },
              "example3": {
                "summary": "Example of from March 2016 and on to present",
                "value": "from+2016-04"
              }
            }
          },
          {
            "name": "CTY_CODE",
            "in": "query",
            "style": "form",
            "explode": true,
            "required": false,
            "description": "Specify the country code to filter the export data by country. Exclude this parameter to get data for all countries.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            },
            "examples": {
              "example1": {
                "summary": "Example for Mexico",
                "value": "2010"
              },
              "example2": {
                "summary": "Example for Greenland",
                "value": "1010"
              },
              "example3": {
                "summary": "Example for Canada",
                "value": "1220"
              }
            }
          },
          {
            "name": "E_COMMODITY",
            "in": "query",
            "required": false,
            "description": "The 2, 4, 6, or 10-character Export Harmonized System Code.",
            "schema": {
              "type": "string",
              "pattern": "^\\\\d{2}|\\\\d{4}|\\\\d{6}|\\\\d{10}$",
              "example": "1010"
            }
          }
        ]
      }
    }
  }
}

Title

Title

  • GET /qrsThe database contains detailed information on export and import prohibitions and restrictions other than tariffs and taxes. Search using product HS or description. Preferably use HS code.
Schéma original API
{
  "openapi": "3.0.3",
  "info": {
    "title": "Title",
    "description": "Title",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.wto.org/qr/v1"
    }
  ],
  "paths": {
    "/qrs": {
      "get": {
        "tags": [
          "QRs"
        ],
        "summary": "The database contains detailed information on export and import prohibitions and restrictions other than tariffs and taxes. Search using product HS or description. Preferably use HS code.",
        "operationId": "getWTORestrictions",
        "parameters": [
          {
            "name": "locale",
            "in": "query",
            "description": "Language.",
            "schema": {
              "enum": [
                "en",
                "es",
                "fr"
              ],
              "type": "string",
              "default": "en"
            }
          },
          {
            "name": "product[hs_version]",
            "in": "query",
            "required": true,
            "description": "Measure Product hs version.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "product[description]",
            "in": "query",
            "description": "Measure Product reported product description.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "422": {
            "description": "Response if one or more of the the query parameters are malformed or doesn't comply with the given constraints. Ex. validation of paramters failed.",
            "content": {
              "application/json": {
                "example": {
                  "code": "404",
                  "message": "Resource not found."
                }
              }
            }
          }
        }
      }
    }
  }
}