{
  "openapi": "3.0.1",
  "info": {
    "title": "NuGet Scraper · .NET Packages, Versions, Downloads & Authors",
    "description": "Scrape NuGet .NET packages, versions, download counts, authors, tags, and dependencies. Search by keyword, tag, framework, author, or package ID prefix.",
    "version": "1.0",
    "x-build-id": "C5wVLKv5LFy0k3XHh"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/reapx~nuget-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-reapx-nuget-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/reapx~nuget-scraper/runs": {
      "post": {
        "operationId": "runs-sync-reapx-nuget-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/reapx~nuget-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-reapx-nuget-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",
        "required": [
          "query",
          "maxItems",
          "maxPages"
        ],
        "properties": {
          "query": {
            "title": "Search Query",
            "type": "string",
            "description": "<b>Search query string</b> for NuGet packages. Supports free text (e.g. <code>json</code>), tag filters (e.g. <code>tag:logging</code>), target framework (e.g. <code>framework:net8.0</code>), author (e.g. <code>author:microsoft</code>), or package ID prefix (e.g. <code>id:Serilog</code>).<br><br>Leave empty to search popular default packages. Broad queries return more package records, increasing execution time and pay-per-event charges."
          },
          "includePrerelease": {
            "title": "Include Prerelease",
            "type": "boolean",
            "description": "<b>Include pre-release packages</b> (alpha, beta, RC versions) in search results. When enabled, pre-release package metadata is scraped alongside stable releases.<br><br>When disabled (default), only stable release packages are returned. Disabling pre-release excludes unfinished packages and speeds up processing."
          },
          "packageType": {
            "title": "Package Type",
            "enum": [
              "",
              "Dependency",
              "DotnetTool",
              "Template"
            ],
            "type": "string",
            "description": "Narrow the search to one kind of NuGet package: a library, a .NET CLI tool or a project/item template.<br><br><b>Empty value:</b> leave empty to search every package type, which is what nuget.org itself does.<br><br><b>Consequence:</b> this filter is applied by the search service, not afterwards, so it makes runs cheaper rather than more expensive. Measured live: <code>json</code> matches 11,017 packages, <code>json</code> restricted to .NET tools matches 350."
          },
          "includeDependencies": {
            "title": "Include Dependencies & Publish Date",
            "type": "boolean",
            "description": "Read each package's registration index and add <code>dependencies</code>, <code>dependencyCount</code>, <code>targetFrameworks</code>, <code>published</code>, <code>licenseExpression</code> and <code>listed</code>. The search endpoint carries none of those at any page size.<br><br><b>Turned off (the default):</b> those six fields stay empty, <code>0</code> and <code>true</code>.<br><br><b>Consequence:</b> one extra request per package, run 5 at a time, so a 500-package run takes noticeably longer. It adds no rows and no charge."
          },
          "minDownloads": {
            "title": "Minimum Downloads",
            "minimum": 0,
            "type": "integer",
            "description": "<b>Minimum total download count</b> filter. Package records with fewer total downloads than this value will be excluded from the dataset results.<br><br>Leave empty for no minimum download constraint. Setting a minimum download limit filters out obscure packages and reduces dataset noise."
          },
          "maxItems": {
            "title": "Max Items",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "<b>Maximum package records</b> to return and push to the default dataset (1 to 5,000).<br><br>Default is <code>50</code> package records for fast execution. The higher the number, the longer the run takes and the more pay-per-event credits are consumed.<br><br>The higher the number, the longer the run takes and the more you are charged, because you pay per row returned.",
            "default": 50
          },
          "maxPages": {
            "title": "Max Pages",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "<b>Maximum search result pages</b> to fetch from the NuGet V3 search API (1 to 100). Each page retrieves up to 100 package items.<br><br>Default is <code>5</code> pages. Higher page limits allow scraping deeper into search results but increase overall execution time.<br><br>The higher the number, the longer the run takes and the more you are charged, because you pay per row returned.",
            "default": 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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}