Skip to content
API REFERENCEv2

HTML table to Ruby array API

Prepare a Ruby array-of-hash text draft from an HTML report table with the TableConvert conversion API. Only extracted table cell text becomes a code fixture; links, script behavior and webpage state are not translated.

REST APIv2 · Direct outputHTML table → Ruby array draft1 credits per successful conversion

Try this conversion

Inspect a real sample, preview locally, or send a live request with your own key.

Verified sample
POSThttps://api.tableconvert.com/v2/convert/html-to-ruby

Ruby array draft response

[
    {"val0"=>"name","val1"=>"country","val2"=>"role"}
    {"val0"=>"Alice","val1"=>"GB","val2"=>"editor"}
    {"val0"=>"Bob","val1"=>"FR","val2"=>"viewer"}
];

Local previews use no credits and process the first imported table or worksheet.

A successful live request uses 1 credits.

Your key is sent only to the conversion API and is never saved by this page.

Things to check before integrating

Before you integrate

Extract a simple table and remove layout-only merged cells before converting it.

Before you integrate

The current generator omits commas between hashes; repair syntax and string escaping before running Ruby.

Code examples

These examples send the sample as multipart/form-data and save the returned bytes unchanged. Set TABLECONVERT_API_KEY in your environment.

HTML table to Ruby array API · cURL

curl --fail-with-body --max-time 40 \
  'https://api.tableconvert.com/v2/convert/html-to-ruby' \
  --header "Authorization: Bearer $TABLECONVERT_API_KEY" \
  --form-string 'data=<table>
    <tr>
        <td>name</td>
        <td>country</td>
        <td>role</td>
    </tr>
    <tr>
        <td>Alice</td>
        <td>GB</td>
        <td>editor</td>
    </tr>
    <tr>
        <td>Bob</td>
        <td>FR</td>
        <td>viewer</td>
    </tr>
</table>' \
  --output 'html-to-ruby.rb'

Requires cURL. Download the sample input first when this example uploads a file.

Authentication

Send Authorization: Bearer YOUR_API_KEY. Let the HTTP client set the multipart boundary; do not set Content-Type manually.

Keep production API keys in server-side environment variables.

Request parameters

This importer extracts table, row and cell contents from HTML markup. It is a table-data converter, not a whole-page browser renderer.

ParameterTypeDefaultDescription
datastring—Inline HTML table content. Choose one of data, file or url.
filebinary—Upload a html file using multipart/form-data.
urlstring—A supported publicly accessible HTTP or HTTPS file URL.

Send one source: data, file, or url. The examples below use the source mode appropriate for this format.

Output options

Generate an array-of-hash text draft using positional val keys. The current multirow generator omits commas between adjacent hashes, so the complete output needs syntax repair.

This output format does not expose additional options.

Conversion rules

CaseBehavior
Mapping rule 1HTML tr elements become rows and th/td contents become cells after inner tags are removed.
Mapping rule 2Each table row is drafted as a hash with positional keys rather than header-named attributes.
Mapping rule 3Only extracted table cell text becomes a code fixture; links, script behavior and webpage state are not translated.

How the input is read

  • Supply an HTML table containing explicit tr and th/td elements.
  • Tags inside cells are stripped; CSS, links, images and page layout are not preserved as visual elements.
  • Simplify colspan, rowspan and nested tables before conversion; the parser extracts cells rather than reconstructing browser layout.
  • Multiple table elements are separate extracted tables; confirm which table your request converts.

How the output is written

  • Rows, including the header, become hashes keyed by val0, val1 and so on.
  • Insert commas between adjacent hashes; a native ruby -c check rejects the unadapted multirow output.
  • Review string escaping and run your Ruby syntax check after adapting the draft.

When to use this API

This conversion in practice

Use an HTML report table as the starting dataset for a Ruby fixture mapping that will be adapted and syntax-checked. Extract a simple table and remove layout-only merged cells before converting it.

Ruby array draft

Use a generated mapping draft as a starting point for a Ruby test fixture.

Responses and errors

HTTP statusDescription
200text/plain; charset=utf-8
400Invalid input or conversion parameters.
402Insufficient credits for this request.
403Missing or invalid API key.
413The input exceeds the configured request limit.
415Unsupported input media type.
429Rate limit exceeded.
500The conversion could not be completed.
503The renderer is unavailable or the request timed out.

Check the response before retrying. A new HTTP request is a new conversion and may use credits again.

Limits, billing and versions

Local previews accept up to 200 KB. The current API implementation allows one uploaded file up to 50 MiB, limits each multipart text field to 1 MiB, and gives v2 conversion tasks a 30-second deadline. Deployment limits may be stricter. Read the returned error before retrying; some parser or renderer failures return HTTP 500.

Live calls follow the API credit policy. Failed conversions are refunded; a completed conversion is not undone if the download connection later fails.

View API pricing and credits

Using API v1?

This page documents v2, which returns the output directly. API v1 wraps the result in a JSON envelope. Check the overview before changing an existing integration.

API overview

References and format specifications

Format references explain the underlying syntax. The conversion rules and samples above describe TableConvert’s implementation.