Markdown Table Generator

Overview

The table is built from `headers` and `rows`. The header row is written as `| a | b | c |`, followed by a separator row whose cells depend on alignment: `---` for left, `:---:` for center and `---:` for right. Each entry in `rows` is an array of cell values in header order.

Rows are normalised to the header length. A short row is padded with empty cells and a long row is cut to the number of headers, so extra values are dropped silently. Each cell is converted to a string, `|` is escaped as `\|`, and line breaks are replaced with a space so a cell never spills onto a new line. `null` and `undefined` become empty cells. Cells are not padded to equal widths, which keeps the output compact; markdown renderers align columns themselves.

`alignment` takes either a single value applied to every column or an array with one entry per column. A shorter array is filled out with `left`. Any value other than `center` or `right` renders as a plain `---` separator. `columnCount` is the number of headers, `rowCount` the number of data rows, and `cellCount` counts the header row as well, so 3 columns and 3 rows give 12. `alignments` echoes the values applied per column. On the Free plan `rowCount`, `cellCount` and `alignments` are null, though the markdown itself still honours your alignment.

Live Test Markdown Table Generator API →

Endpoint

One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.

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

curl -X POST https://api.apiverve.com/v1/markdowntable \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "headers": [
    "Name",
    "Age",
    "City"
  ],
  "rows": [
    [
      "John Doe",
      30,
      "New York"
    ],
    [
      "Jane Smith",
      25,
      "Los Angeles"
    ],
    [
      "Bob Johnson",
      35,
      "Chicago"
    ]
  ],
  "alignment": "left"
}'

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

const res = await fetch('https://api.apiverve.com/v1/markdowntable', {
  method: 'POST',
  headers: {
    'x-api-key': 'your_api_key_here',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "headers": [
    "Name",
    "Age",
    "City"
  ],
  "rows": [
    [
      "John Doe",
      30,
      "New York"
    ],
    [
      "Jane Smith",
      25,
      "Los Angeles"
    ],
    [
      "Bob Johnson",
      35,
      "Chicago"
    ]
  ],
  "alignment": "left"
}),
});

if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);

const { data } = await res.json();
console.log(data);

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

import requests

res = requests.post(
    "https://api.apiverve.com/v1/markdowntable",
    headers={"x-api-key": "your_api_key_here"},
    json={
    "headers": [
        "Name",
        "Age",
        "City"
    ],
    "rows": [
        [
            "John Doe",
            30,
            "New York"
        ],
        [
            "Jane Smith",
            25,
            "Los Angeles"
        ],
        [
            "Bob Johnson",
            35,
            "Chicago"
        ]
    ],
    "alignment": "left"
},
    timeout=15,
)
res.raise_for_status()

print(res.json()["data"])

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
46
47
48

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "headers": [
    "Name",
    "Age",
    "City"
  ],
  "rows": [
    [
      "John Doe",
      30,
      "New York"
    ],
    [
      "Jane Smith",
      25,
      "Los Angeles"
    ],
    [
      "Bob Johnson",
      35,
      "Chicago"
    ]
  ],
  "alignment": "left"
}`)
	req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/markdowntable", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("x-api-key", "your_api_key_here")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.

Authentication

Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.

Parameters

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.

Response

Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

{
  "status": "ok",
  "error": null,
  "data": {
    "markdown": "| Name | Age | City |\n| --- | --- | --- |\n| John Doe | 30 | New York |\n| Jane Smith | 25 | Los Angeles |\n| Bob Johnson | 35 | Chicago |",
    "columnCount": 3,
    "rowCount": 3,
    "cellCount": 12,
    "headers": [
      "Name",
      "Age",
      "City"
    ],
    "alignments": [
      "left",
      "left",
      "left"
    ]
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.

Use cases

Documentation Generation

Create formatted tables for README files and technical documentation

Data Presentation

Convert API responses or datasets into readable markdown tables

Report Building

Generate tabular reports in markdown format for various platforms

Content Management

Create consistent table formatting across documentation systems

Other ways to use Markdown Table Generator

Set up Markdown Table Generator on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.

Related

More in Data Conversion: