{
  "openapi": "3.0.1",
  "info": {
    "title": "INPI Trademark Search: French, EU & International Marks",
    "description": "Search French, EU and international trademarks through the official INPI API: every mark of a search past the 200-per-page limit that drops 30 to 45% of results, search by SIREN of the applicant, Nice classes, filing dates, SIREN and goods from the notice. Uses your free INPI account.",
    "version": "0.1",
    "x-build-id": "I5R1vYpaVu7RUDimB"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/alexmorain~inpi-trademark-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-alexmorain-inpi-trademark-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/alexmorain~inpi-trademark-scraper/runs": {
      "post": {
        "operationId": "runs-sync-alexmorain-inpi-trademark-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/alexmorain~inpi-trademark-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-alexmorain-inpi-trademark-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "inpiUsername": {
            "title": "INPI username (email)",
            "type": "string",
            "description": "Email of your INPI account with API access activated. Requests run on your own account and its INPI quota (100 requests per hour). Leave empty for a 10-mark demo, marks not charged."
          },
          "inpiPassword": {
            "title": "INPI password",
            "type": "string",
            "description": "Password of the same INPI account. Stored encrypted by Apify, never logged."
          },
          "searchTerms": {
            "title": "Trademark names",
            "type": "array",
            "description": "One search per line. Marks containing <b>all</b> the words of the line are returned. Use <code>*</code> as a wildcard: <code>sol*</code> finds soleil, solar, solution.",
            "items": {
              "type": "string"
            }
          },
          "applicantSirens": {
            "title": "Applicant SIREN numbers",
            "type": "array",
            "description": "9-digit SIREN of a French company: returns the French marks it filed, its trademark portfolio. Not available for EU and international marks (INPI does not hold their SIREN). The SIREN is copied into each row, as INPI never returns it.",
            "items": {
              "type": "string"
            }
          },
          "applicantNames": {
            "title": "Applicant or holder names",
            "type": "array",
            "description": "Company or person name, matched on the applicant and on the current holder. All words of the line must match.",
            "items": {
              "type": "string"
            }
          },
          "rawQuery": {
            "title": "Advanced query (INPI syntax)",
            "type": "string",
            "description": "For experts: a query in the INPI search syntax, for example <code>[Mark=apple] OU [Mark=pomme]</code>. The filters below still apply."
          },
          "offices": {
            "title": "Offices",
            "type": "array",
            "description": "<b>FR</b>: French marks (INPI). <b>EU</b>: European Union marks (EUIPO). <b>WO</b>: international marks designating France (WIPO, Madrid). All three by default.",
            "items": {
              "type": "string",
              "enum": [
                "FR",
                "EU",
                "WO"
              ],
              "enumTitles": [
                "France (INPI)",
                "European Union (EUIPO)",
                "International (WIPO)"
              ]
            },
            "default": [
              "FR",
              "EU",
              "WO"
            ]
          },
          "niceClasses": {
            "title": "Nice classes",
            "type": "array",
            "description": "Only marks registered in at least one of these classes. Empty: all classes.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10",
                "11",
                "12",
                "13",
                "14",
                "15",
                "16",
                "17",
                "18",
                "19",
                "20",
                "21",
                "22",
                "23",
                "24",
                "25",
                "26",
                "27",
                "28",
                "29",
                "30",
                "31",
                "32",
                "33",
                "34",
                "35",
                "36",
                "37",
                "38",
                "39",
                "40",
                "41",
                "42",
                "43",
                "44",
                "45"
              ],
              "enumTitles": [
                "1 Chemicals",
                "2 Paints",
                "3 Cosmetics, cleaning",
                "4 Oils, fuels",
                "5 Pharmaceuticals",
                "6 Metals",
                "7 Machines",
                "8 Hand tools",
                "9 Electronics, software",
                "10 Medical devices",
                "11 Lighting, heating",
                "12 Vehicles",
                "13 Firearms",
                "14 Jewellery",
                "15 Musical instruments",
                "16 Paper, printed matter",
                "17 Rubber, plastics",
                "18 Leather goods",
                "19 Building materials",
                "20 Furniture",
                "21 Household utensils",
                "22 Ropes, textiles raw",
                "23 Yarns",
                "24 Textiles",
                "25 Clothing",
                "26 Lace, haberdashery",
                "27 Carpets",
                "28 Games, toys",
                "29 Meat, dairy",
                "30 Coffee, bakery",
                "31 Agriculture",
                "32 Beers, soft drinks",
                "33 Wines, spirits",
                "34 Tobacco",
                "35 Advertising, business",
                "36 Finance, insurance",
                "37 Construction, repair",
                "38 Telecommunications",
                "39 Transport, travel",
                "40 Treatment of materials",
                "41 Education, entertainment",
                "42 Science, software services",
                "43 Food services, lodging",
                "44 Medical, beauty services",
                "45 Legal, security services"
              ]
            }
          },
          "onlyInForce": {
            "title": "Only marks in force",
            "type": "boolean",
            "description": "On: only marks that have not expired today. Off: expired marks too.",
            "default": true
          },
          "filingDateFrom": {
            "title": "Filed from",
            "type": "string",
            "description": "Only marks filed on or after this date. With a filing date range alone, the Actor lists every mark filed in the period: a watch of new filings."
          },
          "filingDateTo": {
            "title": "Filed until",
            "type": "string",
            "description": "Only marks filed on or before this date."
          },
          "maxItems": {
            "title": "Maximum marks",
            "minimum": 1,
            "type": "integer",
            "description": "The run stops after this many unique marks. Each INPI request returns up to 200 marks, and your INPI account allows 100 requests per hour.",
            "default": 1000
          },
          "includeDetails": {
            "title": "Add details from the INPI notice (French marks)",
            "type": "boolean",
            "description": "Reads the full INPI notice of each French mark: <b>SIREN and address of the applicant</b>, full text of the goods and services by class, type of mark, representative, history (publications, registration, renewals).<br><br>One extra INPI request per mark, so about 90 marks per hour with your INPI quota. EU and international marks have no notice in the INPI API and are returned without details, at the basic price.",
            "default": false
          },
          "mode": {
            "title": "Run mode",
            "enum": [
              "all",
              "new-only"
            ],
            "type": "string",
            "description": "<b>New marks only</b> remembers the marks already returned for this input and returns (and charges) only the new ones. Schedule it daily or weekly to watch a name, a competitor or a class for new filings.",
            "default": "all"
          },
          "registryKey": {
            "title": "Monitoring name",
            "type": "string",
            "description": "Optional. By default the memory of seen marks is tied to the exact search and filters. Give a name to keep it when you edit the input."
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "If set, the Actor POSTs a short JSON summary to this URL at the end of the run, <b>only when at least one mark was returned</b>. It carries <code>text</code> and <code>content</code> fields, so a Slack or Discord incoming webhook works as is. An unreachable webhook is logged and never fails the run."
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}