{ "openapi": "3.0.1", "info": { "title": "Map Chart Generator: Data to Choropleth & Bubble Maps", "description": "Turn data into map images: values by country, US state or county, or province of any country as a choropleth, bubbles or categories, or coordinates as points. From JSON, CSV, a link or an Apify dataset to PNG, SVG, PDF or HTML. For AI agents.", "version": "0.1", "x-build-id": "O3Ex2LlGvylZuhHOu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jumblemog~map-chart-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jumblemog-map-chart-generator", "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/jumblemog~map-chart-generator/runs": { "post": { "operationId": "runs-sync-jumblemog-map-chart-generator", "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/jumblemog~map-chart-generator/run-sync": { "post": { "operationId": "run-sync-jumblemog-map-chart-generator", "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": { "data": { "title": "Data rows (JSON)", "type": "array", "description": "Rows as JSON objects, like the items of a scraper's dataset: [{\"country\": \"France\", \"sales\": 120}, ...]. Each row names a region (a country, US state or county, or a province) and has a value, or has latitude and longitude for a point. The columns are found automatically; you can name them in Columns below. Nested fields work with dots, such as location.lat." }, "values": { "title": "Values by region", "type": "object", "description": "The quickest way to give data: region names with their values, such as {\"France\": 120, \"Germany\": 95, \"Spain\": 80}. Values can also be text, which colors the regions by category, such as {\"Texas\": \"Republican\", \"California\": \"Democrat\"}." }, "csv": { "title": "CSV data", "type": "string", "description": "CSV or TSV text with a header row, such as country,sales. Numbers like $1,200 and 45% are understood." }, "datasetId": { "title": "Apify dataset", "type": "string", "description": "A dataset in your Apify account, such as the results of a Google Maps scraper run, to map its items (its ID or name). Places with coordinates become points, or are counted per region with Map type set to colored regions. Up to 100,000 items are read. The tool gets read access to this dataset only." }, "dataUrl": { "title": "Data file link", "type": "string", "description": "A link to a public CSV, TSV or JSON file (up to 30 MB), a GitHub file, or a Google Sheet shared as \"Anyone with the link\". The site's robots.txt is respected." }, "map": { "title": "Map", "enum": [ "auto", "world", "us-states", "us-counties", "provinces", "regions", "continents", "custom" ], "type": "string", "description": "Which regions the names are. Detected from the data: country names give a world map (zoomed to a continent when all the data is there), US state names a US map, county names a county map, and province names (Bavaria, Ontario, Maharashtra...) the provinces of their country.", "default": "auto" }, "country": { "title": "Country (for provinces or regions)", "type": "string", "description": "The country whose provinces or regions to map, by name or code, such as France, DE or JPN. Only needed when Map is set to provinces or regions; detected otherwise." }, "mapType": { "title": "Map type", "enum": [ "auto", "choropleth", "bubble", "points" ], "type": "string", "description": "Colored regions show a value per region; bubbles show amounts as circles; points show places from their coordinates. Rows with coordinates and Map type set to colored regions are counted (or added up) per region.", "default": "auto" }, "focus": { "title": "Zoom to", "type": "array", "description": "Parts of the world or regions to zoom to: a continent (Europe, Africa), a part of the world (Middle East, Southeast Asia, Scandinavia, Balkans, Latin America, Sub-Saharan Africa, European Union), countries, a part of the US (New England, Midwest, West Coast, Lower 48), states (Texas, also on county maps) or provinces. Default: the whole map, or the area with data.", "items": { "type": "string" } }, "projection": { "title": "Projection", "enum": [ "auto", "equalEarth", "naturalEarth1", "mollweide", "mercator", "equirectangular", "conicEqualArea", "conicConformal", "albersUsa", "orthographic", "transverseMercator" ], "type": "string", "description": "How the round earth is drawn flat. Auto uses Equal Earth for the world, Albers USA for the US, and a conic projection turned to the area for countries and continents.", "default": "auto" }, "aggregate": { "title": "Rows for the same region", "enum": [ "auto", "sum", "mean", "median", "min", "max", "count", "first", "last" ], "type": "string", "description": "How to combine several rows for one region, such as many orders per state. Rows with a year or date column show the latest year per region.", "default": "auto" }, "regionField": { "title": "Region column", "type": "string", "description": "The column with the region names or codes. Default: found automatically." }, "valueField": { "title": "Value column", "type": "string", "description": "The column with the values to color by (numbers, or text for categories). Default: the first number column; with none, rows are counted per region." }, "latitudeField": { "title": "Latitude column", "type": "string", "description": "For points: the latitude column, such as lat or location.lat. Default: found automatically." }, "longitudeField": { "title": "Longitude column", "type": "string", "description": "For points: the longitude column, such as lng, lon or location.lng." }, "sizeField": { "title": "Point size column", "type": "string", "description": "For points: a number column that sizes each point as a bubble, such as reviewsCount or population." }, "colorField": { "title": "Point color column", "type": "string", "description": "For points: a column that colors them, by category (such as categoryName) or by number (such as totalScore)." }, "labelField": { "title": "Point label column", "type": "string", "description": "For points: the column with the names to write next to them. Default: title, name or city when there are up to 30 points." }, "colorScheme": { "title": "Color scheme", "enum": [ "auto", "blues", "greens", "greys", "oranges", "purples", "reds", "viridis", "magma", "inferno", "plasma", "cividis", "turbo", "blueGreen", "bluePurple", "goldGreen", "goldOrange", "goldRed", "greenBlue", "orangeRed", "purpleBlueGreen", "purpleBlue", "purpleRed", "redPurple", "yellowGreenBlue", "yellowGreen", "yellowOrangeBrown", "yellowOrangeRed", "darkBlue", "darkGold", "darkGreen", "darkMulti", "darkRed", "lightGreyRed", "lightGreyTeal", "lightMulti", "lightOrange", "lightTealBlue", "blueOrange", "brownBlueGreen", "purpleGreen", "pinkYellowGreen", "purpleOrange", "redBlue", "redGrey", "redYellowBlue", "redYellowGreen", "spectral", "tableau10", "tableau20", "category10", "category20", "set1", "set2", "set3", "dark2", "paired", "pastel1", "pastel2", "accent", "observable10" ], "type": "string", "description": "Colors for the values. Single-hue and multi-hue schemes for amounts, diverging schemes for values around a middle (such as change, + and -), and category schemes for text values.", "default": "auto" }, "classification": { "title": "Color classes", "enum": [ "auto", "continuous", "quantile", "equal", "jenks", "custom" ], "type": "string", "description": "A smooth gradient, or classes with tidy boundaries such as 1.5, 3 and 10.", "default": "auto" }, "classes": { "title": "Number of classes", "minimum": 2, "maximum": 9, "type": "integer", "description": "How many color classes for quantiles, equal intervals and natural breaks.", "default": 5 }, "breaks": { "title": "Class breaks", "type": "array", "description": "Your own class boundaries, such as [10, 20, 50, 100] for five classes: under 10, 10 to 20, 20 to 50, 50 to 100 and 100 or more." }, "colors": { "title": "Custom colors", "type": "array", "description": "Your own colors, used instead of the scheme: from low to high for numbers (two or more, blended), or one per category in order. Any CSS color, such as #f7fbff or navy.", "items": { "type": "string" } }, "categoryColors": { "title": "Colors by category", "type": "object", "description": "A color for each category, such as {\"Yes\": \"#16a34a\", \"No\": \"#dc2626\"}." }, "categoryOrder": { "title": "Category order", "type": "array", "description": "The order of the categories in the legend. Default: the most common first.", "items": { "type": "string" } }, "reverseColors": { "title": "Reverse the colors", "type": "boolean", "description": "Turn the scheme around, such as dark for low values.", "default": false }, "domainMin": { "title": "Lowest value of the scale", "type": "number", "description": "For a smooth gradient: the value that gets the lightest color (lower values get it too). Default: the smallest value." }, "domainMax": { "title": "Highest value of the scale", "type": "number", "description": "For a smooth gradient: the value that gets the darkest color. Default: the largest value." }, "midpoint": { "title": "Middle value", "type": "number", "description": "For diverging schemes: the value in the middle of the colors, such as 0 or 50. Default: 0 when the values cross zero." }, "missingColor": { "title": "No-data color", "type": "string", "description": "The color of regions without data. Default: light gray." }, "title": { "title": "Title", "type": "string", "description": "The map's title, at the top left." }, "subtitle": { "title": "Subtitle", "type": "string", "description": "A smaller line under the title, such as the unit or the year." }, "sourceNote": { "title": "Source note", "type": "string", "description": "A small line at the bottom, such as the data source." }, "labels": { "title": "Region labels", "enum": [ "auto", "none", "names", "values", "namesAndValues", "codes" ], "type": "string", "description": "What to write on the regions. Labels are only drawn where they fit inside a region and don't overlap.", "default": "auto" }, "language": { "title": "Language of region names", "enum": [ "en", "ar", "bn", "de", "el", "es", "fa", "fr", "he", "hi", "hu", "id", "it", "ja", "ko", "nl", "pl", "pt", "ru", "sv", "tr", "uk", "ur", "vi", "zh", "zht" ], "type": "string", "description": "The language of the names on the map and in the results, where the map data has them (all countries, most provinces).", "default": "en" }, "legend": { "title": "Legend", "enum": [ "auto", "bottom", "right", "none" ], "type": "string", "description": "Where the color key goes.", "default": "auto" }, "legendTitle": { "title": "Legend title", "type": "string", "description": "The title over the color key. Default: the value column's name, made readable (gdp_per_capita becomes GDP per capita)." }, "valuePrefix": { "title": "Value prefix", "type": "string", "description": "Put before every number in the legend and labels, such as $." }, "valueSuffix": { "title": "Value suffix", "type": "string", "description": "Put after every number, such as %, M or \" km²\" (with its space)." }, "valueFormat": { "title": "Number format", "type": "string", "description": "A d3 number format for the legend and labels, such as ,.0f (1,234), .1f (12.3), .0% (45%, for values like 0.45), $,.2f or .3~s (1.23M). Default: chosen from the values." }, "locale": { "title": "Number locale", "type": "string", "description": "Thousands and decimal separators, such as en-US (1,234.5), de-DE (1.234,5) or fr-FR (1 234,5).", "default": "en-US" }, "labelSize": { "title": "Label size (px)", "minimum": 6, "maximum": 40, "type": "number", "description": "Font size of the labels on the map. Default: 11 px at a width of 1,000 px, scaled with the width." }, "width": { "title": "Width (px)", "minimum": 300, "maximum": 4000, "type": "integer", "description": "Map width in CSS pixels. PNG files are this times the pixel scale (2,000 px wide by default). The height follows the shape of the area.", "default": 1000 }, "height": { "title": "Height (px)", "minimum": 200, "maximum": 4000, "type": "integer", "description": "A fixed height. Default: what the area's shape needs, so there's no empty space." }, "theme": { "title": "Theme", "enum": [ "light", "dark" ], "type": "string", "description": "Light or dark background and text.", "default": "light" }, "font": { "title": "Font", "enum": [ "Inter", "Roboto", "Open Sans", "Lato", "Montserrat", "Poppins", "Source Sans 3", "Noto Sans", "IBM Plex Sans", "Nunito", "Arial", "Noto Serif", "JetBrains Mono" ], "type": "string", "description": "The font for all text. Chinese, Japanese and Korean names always work.", "default": "Inter" }, "backgroundColor": { "title": "Background color", "type": "string", "description": "Any CSS color, or transparent for a PNG or WebP without a background. Default: white, or dark gray with the dark theme." }, "oceanColor": { "title": "Water color", "type": "string", "description": "A color for the sea behind the land, such as #dbeafe. Default: none (the background)." }, "borderColor": { "title": "Border color", "type": "string", "description": "The color of the lines between regions. Default: the background color." }, "borderWidth": { "title": "Border width (px)", "minimum": 0, "maximum": 5, "type": "number", "description": "The width of the lines between regions. Default: thinner for many small regions." }, "bubbleColor": { "title": "Bubble color", "type": "string", "description": "The color of the bubbles on bubble maps. Default: #e45756 (red)." }, "pointColor": { "title": "Point color", "type": "string", "description": "The color of points that aren't colored by a column. Default: #2563eb (blue)." }, "maxBubbleSize": { "title": "Largest bubble (px)", "minimum": 4, "maximum": 400, "type": "number", "description": "The diameter of the biggest bubble. Default: 7% of the width." }, "pointSize": { "title": "Point size (px)", "minimum": 1, "maximum": 60, "type": "number", "description": "The diameter of points without a size column. Default: smaller when there are many." }, "opacity": { "title": "Bubble and point opacity", "minimum": 0.05, "maximum": 1, "type": "number", "description": "From 0.05 (see-through) to 1 (solid). Default: 0.72 for bubbles, 0.85 for points." }, "includeAntarctica": { "title": "Show Antarctica", "type": "boolean", "description": "Antarctica is left off world maps unless it has data or this is on.", "default": false }, "geojson": { "title": "GeoJSON or TopoJSON map", "type": "object", "description": "Your own map: a GeoJSON FeatureCollection of polygons (such as sales territories, districts or ZIP code areas) or a TopoJSON topology. The data's region names are matched to the features' names (or the property in Feature name property). With no data, the values come from the features' properties." }, "geojsonUrl": { "title": "GeoJSON or TopoJSON link", "type": "string", "description": "A link to a public GeoJSON or TopoJSON file (up to 30 MB) instead." }, "geojsonKeyField": { "title": "Feature name property", "type": "string", "description": "The property of the features that holds the names or codes the data uses, such as NAME or GEOID. Default: name, NAME, id or code." }, "formats": { "title": "File formats", "type": "array", "description": "PNG for chats, emails, docs and slides; SVG and PDF are vector files that stay sharp at any size; WebP is small and lossless; HTML is an interactive page with values on hover; the Vega spec can be embedded in web pages with vega-embed. One charge per map, whatever the number of formats.", "items": { "type": "string", "enum": [ "png", "svg", "pdf", "webp", "jpg", "html", "vega" ], "enumTitles": [ "PNG", "SVG", "PDF", "WebP", "JPEG", "Interactive HTML (hover for values)", "Vega spec (JSON)" ] }, "default": [ "png" ] }, "scale": { "title": "Pixel scale", "minimum": 1, "maximum": 4, "type": "number", "description": "Pixel density of PNG, WebP and JPEG files: 2 (default) is sharp on high-resolution screens, 1 gives smaller files, 3 or 4 for print.", "default": 2 }, "name": { "title": "File name", "type": "string", "description": "A name for the map's files and dataset row. Default: the title or the map's name." }, "inlineImage": { "title": "Include the image in the results", "type": "boolean", "description": "Also put each image in its dataset row as a base64 data URI, for emails and HTML that can't load links. Images up to 2 MB.", "default": false }, "maps": { "title": "More maps (batch)", "type": "array", "description": "More maps in one run. Each entry is an object with its own data and settings, such as {\"values\": {\"France\": 3, \"Spain\": 5}, \"title\": \"Stores\"} or {\"valueField\": \"profit\", \"colorScheme\": \"greens\"}. An entry without data maps the data given above, so one dataset can be drawn several ways. Settings left out come from this form." }, "maxMaps": { "title": "Maximum maps", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop after this many maps, so the cost of a run stays predictable.", "default": 100 } } }, "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 } } } } } } } } } }