{
  "openapi": "3.0.1",
  "info": {
    "title": "France Public Tender Alerts - BOAMP API (Marchés Publics)",
    "description": "$1.50 per 1,000 notices. Daily French public tender alerts (appels d'offres, marchés publics) from BOAMP's official open data (Licence Ouverte 2.0). Filter by keyword, CPV, department or region, contract type, value and deadline; only new notices are returned.",
    "version": "0.1",
    "x-build-id": "1LVzIzp6UrPs7UfCq"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/orange_briefcase_hrj~france-boamp-tender-alerts/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-orange_briefcase_hrj-france-boamp-tender-alerts",
        "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/orange_briefcase_hrj~france-boamp-tender-alerts/runs": {
      "post": {
        "operationId": "runs-sync-orange_briefcase_hrj-france-boamp-tender-alerts",
        "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/orange_briefcase_hrj~france-boamp-tender-alerts/run-sync": {
      "post": {
        "operationId": "run-sync-orange_briefcase_hrj-france-boamp-tender-alerts",
        "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": {
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Words to look for in the title (objet), description and BOAMP descriptors. Case- and accent-insensitive; 'logiciel' also matches 'logiciels'. Leave empty for every notice that matches the other filters.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "keywordMatch": {
            "title": "Keyword match",
            "enum": [
              "any",
              "all"
            ],
            "type": "string",
            "description": "Match notices containing ANY of the keywords, or ALL of them.",
            "default": "any"
          },
          "excludeKeywords": {
            "title": "Exclude keywords",
            "type": "array",
            "description": "Skip notices whose text contains any of these words.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "cpvCodes": {
            "title": "CPV codes",
            "type": "array",
            "description": "Prefix matching on the notice's CPV codes: 72000000 matches every IT service, 45000000 all construction work. Not every BOAMP notice has CPV codes (most national MAPA notices don't), so CPV filters skip those.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "departments": {
            "title": "Departments",
            "type": "array",
            "description": "Department numbers where the contract is performed or published, e.g. 75 (Paris), 69 (Rhône), 13 (Bouches-du-Rhône), 2A, 971. Leave empty for all of France.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "regions": {
            "title": "Regions",
            "type": "array",
            "description": "Regions, expanded to their departments: Île-de-France, Auvergne-Rhône-Alpes, Bourgogne-Franche-Comté, Bretagne, Centre-Val de Loire, Corse, Grand Est, Hauts-de-France, Normandie, Nouvelle-Aquitaine, Occitanie, Pays de la Loire, Provence-Alpes-Côte d'Azur, Outre-mer.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "noticeTypes": {
            "title": "Notice types",
            "type": "array",
            "description": "Contract notices (avis de marché) by default. Add award notices (résultats de marché) to see winners, plus corrections, modifications, prior information and voluntary ex-ante notices.",
            "items": {
              "type": "string",
              "enum": [
                "tender",
                "award",
                "correction",
                "modification",
                "planning",
                "directAwardNotice"
              ],
              "enumTitles": [
                "Contract notices (Avis de marché)",
                "Award notices (Résultat de marché)",
                "Corrections (Rectificatif)",
                "Modifications",
                "Prior information (Avis informatif)",
                "Voluntary ex-ante transparency notices"
              ]
            },
            "default": [
              "tender"
            ]
          },
          "contractTypes": {
            "title": "Contract types",
            "type": "array",
            "description": "Services, supplies or works (services, fournitures, travaux).",
            "items": {
              "type": "string",
              "enum": [
                "services",
                "supplies",
                "works"
              ],
              "enumTitles": [
                "Services",
                "Supplies (Fournitures)",
                "Works (Travaux)"
              ]
            },
            "default": []
          },
          "scope": {
            "title": "EU or national",
            "enum": [
              "all",
              "eu",
              "national"
            ],
            "type": "string",
            "description": "EU-wide procedures (above the EU thresholds, also on TED) or national ones: contracts between €90k and the EU thresholds, MAPA under €90k and concessions, which never reach TED.",
            "default": "all"
          },
          "openOnly": {
            "title": "Only tenders still open",
            "type": "boolean",
            "description": "Skip contract notices whose response deadline has already passed.",
            "default": true
          },
          "minEstimatedValue": {
            "title": "Minimum estimated value (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Only keep notices with an estimated value at or above this. Many notices don't publish a value, so this narrows results a lot."
          },
          "buyerContains": {
            "title": "Buyer name contains",
            "type": "array",
            "description": "Only keep notices whose buyer name contains one of these strings (e.g. 'Région', 'CHU', 'Ville de Paris').",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "lookbackDays": {
            "title": "Look back (days)",
            "minimum": 0,
            "maximum": 90,
            "type": "integer",
            "description": "How many past days of publications to read on a normal run, or on the first run in 'only new' mode (0-90; 0 = today only). BOAMP publishes around 400-600 notices each working day.",
            "default": 2
          },
          "onlyNew": {
            "title": "Only new since last run",
            "type": "boolean",
            "description": "Remember notices already delivered (per filter set) and only output new ones. Off by default so one-off searches always return results; switch it on for scheduled alerts.",
            "default": false
          },
          "stateKey": {
            "title": "Alert name (state key)",
            "type": "string",
            "description": "Optional name for this alert's memory. By default it is derived from your filters, so changing filters starts a fresh alert."
          },
          "includeBuyerContacts": {
            "title": "Include buyer contact details",
            "type": "boolean",
            "description": "Add the buyer's published contact email and phone. Contact details can be personal data: use them only to take part in the procurement, in line with the GDPR.",
            "default": false
          },
          "includeSummary": {
            "title": "Save a summary",
            "type": "boolean",
            "description": "Save a digest (counts by type and department, top buyers, largest and closing-soonest notices) as SUMMARY in the run's key-value store.",
            "default": true
          },
          "maxResults": {
            "title": "Max notices per run",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Stop after this many notices (newest first). In 'only new' mode anything left over is picked up on the next run.",
            "default": 200
          },
          "requestIntervalSecs": {
            "title": "Seconds between API requests",
            "minimum": 0,
            "maximum": 10,
            "type": "number",
            "description": "Minimum pause between requests to the BOAMP API.",
            "default": 0.5
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}