DEV Community: GuGuData

Text Processing APIs for Multilingual Developer Products

GuGuData — Wed, 29 Apr 2026 15:33:40 +0000

Text Processing APIs: Language Detection, Similarity, Chinese Conversion, and Metadata Lookup

Text processing is a common layer in search, publishing, content review, data enrichment, and multilingual products. Applications need to detect languages, compare text, normalize Chinese scripts, enrich book records, or retrieve structured cultural content.

GuGuData text APIs provide focused endpoints for these workflows. This guide explains how to choose the right API and how to combine them safely in backend systems.

API lineup

Workflow	Method	Endpoint	Detail page
Text language detection	`POST`	`/v1/text/detectlanguage`	Detect Text Language
Text similarity	`POST`	`/v1/text/similarity`	Text Similarity Calculator
Simplified and Traditional Chinese conversion	`POST`	`/v1/text/stconvert`	Simplified and Traditional Chinese Converter
Chinese poem lookup	`GET`	`/v1/text/chinese-poem`	Chinese Poem Query
ISBN book metadata lookup	`GET`	`/v1/text/isbn`	ISBN Book Metadata Lookup

The public OpenAPI JSON is available at https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json.

When to use these APIs

Route user content by detected language before translation, moderation, or indexing.
Compare two pieces of text for semantic similarity in search, deduplication, or review workflows.
Normalize Simplified and Traditional Chinese content for publishing and regional display.
Enrich book records from ISBN or title keywords.
Add structured Chinese poem content to education, literature, or cultural products.

Choosing the right endpoint

Use language detection before language-specific processing, especially when input can come from many countries or regions. Use text similarity when the question is whether two text inputs are semantically close enough for your product workflow.

Use Chinese conversion when the script needs to match a target locale. Use ISBN lookup when your source data contains book identifiers or title keywords. Use Chinese poem lookup when the product needs structured poem content rather than free-form search results.

Example requests

Detect the language of text:

curl -X POST "https://api.gugudata.io/v1/text/detectlanguage?appkey=YOUR_APPKEY" \
  -H "Content-Type: application/json" \
  -d '
{
  "content": "GuGuData provides API products for developers around the world."
}
'

Search book metadata by ISBN:

curl "https://api.gugudata.io/v1/text/isbn?appkey=YOUR_APPKEY&isbn=9780141182803&pageIndex=1&pageSize=10"

Response handling

Text APIs use the standard GuGuData JSON response shape:

{
  "dataStatus": {
    "statusCode": 200,
    "status": "SUCCESS",
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-29T00:00:00Z",
    "dataTotalCount": 1,
    "requestParameter": ""
  },
  "data": [
    {
      "Language": "English",
      "LanguageAbbr": "en",
      "Probability": 0.999341
    }
  ]
}

For ranking or confidence-based results, define product-level thresholds in your own service instead of treating every result as equally strong.

HTTP status codes

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check required fields, text length, and query parameters.
`401`	Missing or unknown application key.	Send a valid `appkey` with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Keep API calls server-side so the appkey is not exposed in public frontend code.
Normalize input text before similarity checks if whitespace, punctuation, or casing should not affect your workflow.
Store confidence scores and detected language codes with downstream records.
Use explicit thresholds for automated actions and route uncertain results to review when needed.
Cache stable lookup results such as ISBN metadata when your product allows it.

FAQ

Should I use language detection before translation?

Yes. Language detection helps route content to the right downstream workflow and can reduce incorrect assumptions when users submit multilingual content.

Can text similarity replace business review rules?

No. Treat text similarity as one signal. Product-level thresholds, review queues, and domain-specific rules should still be defined in your own application.

Is ISBN lookup only for exact ISBN searches?

No. The endpoint supports ISBN lookup and keyword search fields, so it can be used for exact book matching and broader title discovery workflows.

For more developer APIs, visit GuGuData.

Web Content Extraction APIs for Data Pipelines

GuGuData — Wed, 29 Apr 2026 15:33:04 +0000

Web Content Extraction APIs: Turn URLs into Readable Data, JSON, Links, and Screenshots

Many developer workflows start with a URL. The next step may be extracting readable article text, converting a page to Markdown, collecting links, capturing a screenshot, or checking website metadata before storing a record.

GuGuData website tools APIs provide URL-focused endpoints that help developers turn web pages and domains into structured outputs for products, data pipelines, and internal automation.

API lineup

Workflow	Method	Endpoint	Detail page
Readable content extraction	`POST`	`/v1/websitetools/readability`	Webpage Readable Content Extraction
URL to HTML	`POST`	`/v1/websitetools/url2html`	Fetch Rendered HTML from URL
URL to Markdown	`POST`	`/v1/websitetools/url2markdown`	Convert URL to Markdown
URL to structured JSON	`POST`	`/v1/websitetools/url2json`	Extract Structured JSON from Webpage
URL to links	`POST`	`/v1/websitetools/url2links`	Extract Links from URL
URL screenshot	`POST`	`/v1/websitetools/url2snapshot`	Webpage Screenshot Capture
URL to image	`POST`	`/v1/websitetools/url2image`	Convert URL to Image
URL to static file	`POST`	`/v1/websitetools/url2html`	URL to Static File
Favicon lookup	`GET`	`/v1/websitetools/favicon`	Website Favicon Extraction
DNS lookup	`GET`	`/v1/websitetools/dns-lookup`	Domain DNS Information Query
SSL certificate info	`GET`	`/v1/websitetools/sslcertinfo`	Domain SSL Certificate Information Parsing
WHOIS lookup	`GET`	`/v1/websitetools/whois`	Domain WHOIS Information Lookup

The public OpenAPI JSON is available at https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json.

When to use these APIs

Build article ingestion pipelines that need readable page content.
Convert web pages into Markdown for knowledge bases, AI workflows, or archival systems.
Extract structured JSON from pages using a prompt-driven workflow.
Capture page screenshots for review, monitoring, or visual records.
Audit domain metadata such as DNS records, SSL certificates, favicon, or WHOIS data.
Normalize URL processing behind one server-side integration layer.

Choosing the right endpoint

Use readability extraction when your goal is the main article body. Use URL to Markdown when the output needs to be readable, portable, and friendly to documentation or AI workflows.

Use URL to JSON when the page has fields you want to extract into a structured shape. Use URL to links when you need discovery, crawling, or link inventory.

Use screenshot and image endpoints when the visual state of the page matters. Use DNS, SSL, favicon, and WHOIS endpoints when the domain itself is the target.

Example request

curl -X POST "https://api.gugudata.io/v1/websitetools/url2json?appkey=YOUR_APPKEY" \
  -H "Content-Type: application/json" \
  -d '
{
  "url": "https://example.com/article",
  "prompt": "Extract the article title, author, published date, and a short summary."
}
'

Response handling

Most website tools return standard JSON responses with dataStatus and data. The exact data shape depends on the endpoint.

{
  "dataStatus": {
    "statusCode": 200,
    "status": "SUCCESS",
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-29T00:00:00Z",
    "dataTotalCount": 1,
    "requestParameter": ""
  },
  "data": {
    "title": "Example article",
    "summary": "Short extracted summary"
  }
}

For URL workflows, store the original URL, request time, and endpoint name with the result. This makes retries, audits, and freshness checks easier.

HTTP status codes

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check URL format, prompt content, and request body structure.
`401`	Missing or unknown application key.	Send a valid `appkey` with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Validate and normalize URLs before calling extraction endpoints.
Keep URL processing on the backend so credentials and retry behavior remain controlled.
Add timeouts around downstream workflows because external pages can be slow or unavailable.
Store extraction metadata so results can be refreshed without losing the original request context.
Use demo endpoints for quick checks, then move to authenticated production endpoints.

FAQ

Which endpoint should I use for AI ingestion?

Use Convert URL to Markdown when readable text is enough. Use Extract Structured JSON from Webpage when you need specific fields.

Should I crawl large sites directly from these endpoints?

Use controlled queues and rate limits. URL processing depends on external pages, so retries and concurrency limits should be explicit in your own system.

Can I combine metadata checks with content extraction?

Yes. For example, you can check DNS or SSL metadata before extracting page content, then store both the domain-level record and the page-level output.

For more developer APIs, visit GuGuData.

QR Code and Barcode APIs for Product Workflows

GuGuData — Wed, 29 Apr 2026 15:31:43 +0000

QR Code and Barcode APIs: Generation, Wi-Fi Access, and Image Decoding

QR codes and barcodes are small integration points that often sit inside larger business workflows. A product may need to generate a payment code, print a logistics label, add Wi-Fi access to onboarding material, or decode QR code images submitted by users.

GuGuData provides APIs for QR code generation, Wi-Fi QR code generation, general barcode generation, and QR code image decoding. This guide explains how these endpoints fit into practical product workflows.

API lineup

Workflow	Method	Endpoint	Detail page
QR code generation	`POST`	`/v1/qrcode`	Universal QR Code Generator
Wi-Fi QR code generation	`POST`	`/v1/wifi-qrcode`	Wi-Fi QR Code Generator
Barcode generation	`POST`	`/v1/barcode`	General Barcode Generation
QR code image decoding	`POST`	`/v1/barcode/qrcode/decode`	Decode QR Code from Image

The public OpenAPI JSON is available at https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json.

When to use these APIs

Generate QR codes for URLs, internal identifiers, invitation links, or operational handoff flows.
Create Wi-Fi QR codes for offices, hotels, events, or onboarding screens.
Generate barcodes for product labels, warehouse workflows, or printed forms.
Decode QR code images uploaded by users or extracted from documents.
Standardize code generation and decoding logic across multiple services.

Choosing the right endpoint

Use /v1/qrcode when the payload is general text or a URL. Use /v1/wifi-qrcode when the payload is a Wi-Fi network configuration and the code should be scannable by common mobile devices.

Use /v1/barcode when you need a one-dimensional barcode for product, inventory, or operational labels. Use /v1/barcode/qrcode/decode when the input is an image and your application needs the decoded value rather than a generated image.

Example requests

Generate a QR code:

curl -X POST "https://api.gugudata.io/v1/qrcode?appkey=YOUR_APPKEY" \
  -H "Content-Type: application/json" \
  -d '
{
  "content": "https://www.gugudata.io",
  "size": 200
}
'

Decode a QR code image:

curl -X POST "https://api.gugudata.io/v1/barcode/qrcode/decode?appkey=YOUR_APPKEY" \
  -F "file=@./qrcode.png"

Response handling

Generation endpoints usually return a URL to the generated image. Decoding returns the parsed payload and detection details:

{
  "dataStatus": {
    "statusCode": 200,
    "status": "SUCCESS",
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-29T00:00:00Z",
    "dataTotalCount": 1,
    "requestParameter": ""
  },
  "data": {
    "raw": "https://www.gugudata.io",
    "type": "QRCODE",
    "format": "QR_CODE",
    "parsed": ["https://www.gugudata.io"],
    "points": []
  }
}

Treat decoded values as user input. Validate URLs, identifiers, and business payloads before using them in privileged workflows.

HTTP status codes

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check required fields, uploaded image format, size, and barcode type.
`401`	Missing or unknown application key.	Send a valid `appkey` with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Normalize payloads before generating QR codes so duplicate business records do not produce inconsistent codes.
Use server-side requests when the appkey must remain private.
Validate decoded payloads before redirecting users or writing values into your database.
Keep image upload size limits explicit for decoding workflows.
Use demo endpoints for quick checks, then move to authenticated production endpoints.

FAQ

Can I generate Wi-Fi QR codes with the general QR code endpoint?

Use the Wi-Fi QR code endpoint when the payload represents Wi-Fi access. It keeps the request fields clearer and better aligned with Wi-Fi QR code use cases.

Should I trust decoded QR code content automatically?

No. Decoded values can contain arbitrary text or URLs. Validate the payload against your product rules before acting on it.

Which endpoint should I use for printed product labels?

Use General Barcode Generation when the label requires a standard barcode, and use Universal QR Code Generator when the label should carry a URL or flexible text payload.

For more developer APIs, visit GuGuData.

Document Conversion APIs for Developer Workflows

GuGuData — Wed, 29 Apr 2026 15:31:34 +0000

Document Conversion APIs: Build Reliable HTML, PDF, Word, and PowerPoint Workflows

Document conversion is often a hidden part of product infrastructure. Reporting tools export PDF files, publishing systems transform HTML into shareable documents, and business platforms need to normalize user-uploaded files before downstream processing.

GuGuData provides a set of document conversion APIs that can be used from backend services, internal tools, automation pipelines, and data workflows. This guide explains how the APIs fit together and when to use each endpoint.

API lineup

Workflow	Method	Endpoint	Detail page
HTML to PDF	`POST`	`/v1/imagerecognition/html2pdf`	HTML/URL to PDF
Markdown to PDF	`POST`	`/v1/imagerecognition/markdown2pdf`	Markdown to PDF
PDF parsing and formatted output	`POST`	`/v1/imagerecognition/pdf2format`	PDF Parsing and Formatted Output
PDF split	`POST`	`/v1/imagerecognition/pdf-splitter`	PDF Splitter
PDF summary	`POST`	`/v1/imagerecognition/pdf-summary`	PDF Summary
PDF to HTML	`POST`	`/v1/imagerecognition/pdf2html`	PDF to HTML
Word to HTML	`POST`	`/v1/imagerecognition/word-to-html`	Convert Word to HTML
HTML to Word	`POST`	`/v1/imagerecognition/html2word`	Convert HTML to Word
PPT to images	`POST`	`/v1/imagerecognition/ppt-to-images`	Convert PPT to Images
PPT to PDF	`POST`	`/v1/imagerecognition/ppt-to-pdf`	Convert PPT to PDF

The public OpenAPI JSON is available at https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json.

When to use these APIs

Generate PDF versions of invoices, reports, articles, or internal documents.
Convert uploaded Word, PDF, or PowerPoint files into web-friendly outputs.
Create preview images from presentations for search, review, or thumbnail workflows.
Normalize document content before indexing, summarization, storage, or review.
Replace manual office-document export steps in operational workflows.

Choosing the right endpoint

Use HTML to PDF when your source content is already rendered as HTML or when your system controls the page layout. Use Markdown to PDF when the source content comes from developer documentation, notes, or publishing pipelines.

Use PDF parsing, PDF summary, or PDF to HTML when the input is already a PDF and you need structured output, readable content, or a web-friendly representation.

Use Word to HTML when users upload Word documents and your application needs to display or process the content in a browser. Use HTML to Word when your source of truth is web content but the user needs a downloadable Word document.

Use PPT to images for visual previews and slide thumbnails. Use PPT to PDF when the output should preserve the presentation as a single shareable document.

Integration pattern

Most document endpoints are best called from a trusted backend service. Keep appkey out of browser code and store it only in server-side configuration.

curl -X POST "https://api.gugudata.io/v1/imagerecognition/ppt-to-pdf?appkey=YOUR_APPKEY" \
  -F "file=@./presentation.pptx"

For JSON-based endpoints, send a JSON request body:

curl -X POST "https://api.gugudata.io/v1/imagerecognition/markdown2pdf?appkey=YOUR_APPKEY" \
  -H "Content-Type: application/json" \
  -d '
{
  "content": "# Quarterly Report\n\nThis report is generated automatically."
}
'

Response handling

Successful responses use the standard GuGuData response shape when JSON is returned:

{
  "dataStatus": {
    "statusCode": 200,
    "status": "SUCCESS",
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-29T00:00:00Z",
    "dataTotalCount": 1,
    "requestParameter": ""
  },
  "data": {
    "pdfPath": "https://storage.gugudata.io/pdf/example.pdf"
  }
}

For file conversion workflows, store the returned URL only according to your own retention and access-control requirements.

HTTP status codes

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check required fields, file type, file size, and request body format.
`401`	Missing or unknown application key.	Send a valid `appkey` with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Validate file extension and content type before uploading files.
Avoid sending large files from client-side code directly with a public key.
Use demo endpoints for connectivity checks, then switch to authenticated production endpoints.
Add conservative retries for 429, 500, and 503 responses.
Keep conversion jobs idempotent in your own system so a retry does not create duplicate business records.

FAQ

Should document conversion run in frontend code?

No. Use a backend service so the appkey stays private and file upload behavior can be validated, logged, and rate limited.

Which endpoint should I use for preview images?

Use Convert PPT to Images for slide previews and PDF to HTML when you need a browser-friendly document representation.

Can I combine multiple APIs in one workflow?

Yes. A common pattern is to convert uploaded files first, then pass the resulting text or URL into downstream extraction, summarization, or indexing steps.

For more developer APIs, visit GuGuData.

Convert PPT to PDF API Documentation

GuGuData — Fri, 17 Apr 2026 13:53:19 +0000

Convert PPT to PDF API: Technical Guide and Integration Notes

The Convert PPT to PDF API from GuGuData helps developers convert PowerPoint presentations into PDF format with high-quality output.

This article is written for developers who want a crawlable, readable reference before integrating the endpoint into a product, data pipeline, internal tool, or technical workflow. The official detail page is https://gugudata.io/details/ppt2pdf.

API details

Item	Value
API name	Convert PPT to PDF
Category	Document and Image APIs
Method	`POST`
Endpoint	`https://api.gugudata.io/v1/imagerecognition/ppt-to-pdf`
Content type	`multipart/form-data`
Demo endpoint	https://api.gugudata.io/v1/imagerecognition/ppt-to-pdf/demo
Detail page	https://gugudata.io/details/ppt2pdf

When to use this API

Convert PPTX presentations to PDF for sharing, reporting, or archiving.
Preserve slide layout and formatting in a downloadable PDF output.
Automate manual PowerPoint export steps in business tools and content workflows.

Request parameters

This endpoint accepts parameters through the query string plus request body. Keep appkey out of client-side public code and send it only from trusted server-side environments.

Parameter	Type	Required	Default	Description
`appkey`	`string`	Yes	`YOUR_APPKEY`	Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
`file`	`file`	Yes	-	PowerPoint file to convert. PPTX format is supported.

Example request

curl -X POST "https://api.gugudata.io/v1/imagerecognition/ppt-to-pdf?appkey=YOUR_APPKEY" \
  -F "file=@./presentation.pptx"

Response fields

The response body contains the fields below for successful JSON responses. For binary endpoints, the success response is returned as binary content and JSON is used for error responses.

Field	Type	Required	Description
`dataStatus`	`object`	Yes	Response metadata returned by the API response.
`dataStatus.requestParameter`	`string`	Yes	Normalized request parameters echoed by the service. Sensitive credentials are omitted when available.
`dataStatus.statusCode`	`integer`	Yes	Application-level status code returned by the API response.
`dataStatus.statusDescription`	`string`	Yes	Application-level status message returned by the API response.
`dataStatus.responseDateTime`	`string`	Yes	Response timestamp returned by the API response.
`dataStatus.dataTotalCount`	`integer`	Yes	Total number of records that match the request.
`data`	`object`	Yes	Primary response payload returned by the endpoint.
`data.pdfPath`	`string`	Yes	CDN URL for the generated PDF file.

Response example

{
  "dataStatus": {
    "statusCode": 200,
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-17T00:00:00Z",
    "dataTotalCount": 1,
    "requestParameter": ""
  },
  "data": {
    "pdfPath": "https://cdn.example.com/presentation.pdf"
  }
}

HTTP status codes

Use the HTTP status code for transport-level handling. If the response body contains dataStatus.statusCode, treat it as an application-level status field in the JSON payload.

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check required fields, data types, and request body format.
`401`	Missing or unknown application key.	Send a valid appkey with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Validate the uploaded file type before sending the request.
Keep server-side retries conservative for 429, 500, and 503 responses.
Store the returned PDF URL only according to your own retention and access-control requirements.
Log the HTTP status code and dataStatus.statusDescription together for easier debugging.
Use the demo endpoint for a quick connectivity check, then switch to the authenticated endpoint for production data.

FAQ

Where is the official API detail page?

The official detail page is https://gugudata.io/details/ppt2pdf. It is the best place to review the latest public endpoint information before publishing or integrating.

Should I handle `dataStatus.statusCode` as the HTTP status code?

No. Use the HTTP status code for request-level behavior such as authentication, permission, rate limiting, and server errors. Use dataStatus.statusCode only as the response body status field when it is present.

Can I use the demo endpoint in production?

No. The demo endpoint is for quick testing and examples. Use the authenticated endpoint with your appkey for production workflows.

Related GuGuData APIs

For more developer APIs, visit GuGuData.

ISBN Book Metadata Lookup API Documentation

GuGuData — Fri, 17 Apr 2026 13:53:18 +0000

ISBN Book Metadata Lookup API: Technical Guide and Integration Notes

The ISBN Book Metadata Lookup API from GuGuData helps developers search book metadata by ISBN or title keywords and retrieve title, author, publisher, cover image, and publishing details.

API details

Item	Value
API name	ISBN Book Metadata Lookup
Category	Text Processing APIs
Method	`GET`
Endpoint	`https://api.gugudata.io/v1/text/isbn`
Content type	`query parameters`
Demo endpoint	https://api.gugudata.io/v1/text/isbn/demo
Detail page	https://gugudata.io/details/isbn

When to use this API

Look up book metadata by ISBN for cataloging and bookstore workflows.
Search books by title keywords when an ISBN is unavailable.
Enrich publishing, library, education, and content management applications.

Request parameters

This endpoint accepts parameters through the query string. Keep appkey out of client-side public code and send it only from trusted server-side environments.

Parameter	Type	Required	Default	Description
`appkey`	`string`	Yes	`YOUR_APPKEY`	Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
`isbn`	`string`	No	-	ISBN number for an exact book lookup.
`keywords`	`string`	No	-	Book title keywords for fuzzy search.
`pageIndex`	`integer`	No	`1`	Page number used for keyword search.
`pageSize`	`integer`	No	`10`	Page size used for keyword search.

Example request

curl -G "https://api.gugudata.io/v1/text/isbn" \
  --data-urlencode "appkey=YOUR_APPKEY" \
  --data-urlencode "isbn=9780132350884" \
  --data-urlencode "pageIndex=1" \
  --data-urlencode "pageSize=10"

Response fields

The response body contains the fields below for successful JSON responses. For binary endpoints, the success response is returned as binary content and JSON is used for error responses.

Field	Type	Required	Description
`dataStatus`	`object`	Yes	Response metadata returned by the API response.
`dataStatus.requestParameter`	`string`	Yes	Normalized request parameters echoed by the service. Sensitive credentials are omitted when available.
`dataStatus.statusCode`	`integer`	Yes	Application-level status code returned by the API response.
`dataStatus.statusDescription`	`string`	Yes	Application-level status message returned by the API response.
`dataStatus.responseDateTime`	`string`	Yes	Response timestamp returned by the API response.
`dataStatus.dataTotalCount`	`integer`	Yes	Total number of records that match the request.
`data`	`array<object>`	Yes	Book metadata records returned by the endpoint.
`data[].Title`	`string`	No	Book title.
`data[].Author`	`string`	No	Author name.
`data[].ISBN`	`string`	No	ISBN number of the book.
`data[].Publisher`	`string`	No	Publisher name.
`data[].PublisherDateTime`	`string`	No	Publication date or year.
`data[].PageNumber`	`integer`	No	Number of pages.
`data[].Binding`	`string`	No	Binding type.
`data[].BriefIntroduction`	`string`	No	Short introduction or summary.
`data[].CoverImage`	`string`	No	Book cover image URL.

Response example

{
  "dataStatus": {
    "statusCode": 200,
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-17T00:00:00Z",
    "dataTotalCount": 1,
    "requestParameter": ""
  },
  "data": [
    {
      "Title": "Sample Book",
      "Author": "Sample Author",
      "ISBN": "9780132350884",
      "Publisher": "Sample Publisher",
      "PublisherDateTime": "2026",
      "PageNumber": 320,
      "Binding": "Paperback",
      "BriefIntroduction": "Sample introduction",
      "CoverImage": "https://example.com/cover.jpg"
    }
  ]
}

HTTP status codes

Use the HTTP status code for transport-level handling. If the response body contains dataStatus.statusCode, treat it as an application-level status field in the JSON payload.

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check required fields, data types, and request body format.
`401`	Missing or unknown application key.	Send a valid appkey with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Prefer isbn for exact lookup and use keywords with pagination for discovery workflows.
Validate that at least one lookup parameter is provided before sending the request.
Cache stable book metadata when your use case allows it.
Log the HTTP status code and dataStatus.statusDescription together for easier debugging.
Use the demo endpoint for a quick connectivity check, then switch to the authenticated endpoint for production data.

FAQ

Where is the official API detail page?

The official detail page is https://gugudata.io/details/isbn. It is the best place to review the latest public endpoint information before publishing or integrating.

Should I handle `dataStatus.statusCode` as the HTTP status code?

Can I use the demo endpoint in production?

No. The demo endpoint is for quick testing and examples. Use the authenticated endpoint with your appkey for production workflows.

Related GuGuData APIs

For more developer APIs, visit GuGuData.

Convert HTML to Word API Documentation

GuGuData — Fri, 17 Apr 2026 13:52:14 +0000

Convert HTML to Word API: Technical Guide and Integration Notes

The Convert HTML to Word API from GuGuData helps developers convert HTML content or a webpage URL into a Word document that is ready to download, archive, or share.

API details

Item	Value
API name	Convert HTML to Word
Category	Document and Image APIs
Method	`POST`
Endpoint	`https://api.gugudata.io/v1/imagerecognition/html2word`
Content type	`multipart/form-data`
Demo endpoint	https://api.gugudata.io/v1/imagerecognition/html2word/demo
Detail page	https://gugudata.io/details/html2word

When to use this API

Convert raw HTML strings into editable Word documents.
Export webpage content to .docx files for reports, archives, and publishing workflows.
Add document export to CMS, internal tools, and business documentation systems.

Request parameters

This endpoint accepts parameters through the query string plus request body. Keep appkey out of client-side public code and send it only from trusted server-side environments.

Parameter	Type	Required	Default	Description
`appkey`	`string`	Yes	`YOUR_APPKEY`	Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
`content`	`string`	Yes	-	HTML string or webpage URL to convert. Send this parameter as multipart form data.
`type`	`string`	Yes	`html`	Request type. Supported values are `html` and `url`. Send this parameter as multipart form data.
`filename`	`string`	No	-	Optional output file name ending in `.docx`. Send this parameter as multipart form data.

Example request

curl -X POST "https://api.gugudata.io/v1/imagerecognition/html2word?appkey=YOUR_APPKEY" \
  -F "type=html" \
  -F "content=<h1>Quarterly Report</h1><p>Summary content.</p>" \
  -F "filename=quarterly-report.docx"

Response fields

The response body contains the fields below for successful JSON responses. For binary endpoints, the success response is returned as binary content and JSON is used for error responses.

Field	Type	Required	Description
`dataStatus`	`object`	Yes	Response metadata returned by the API response.
`dataStatus.requestParameter`	`string`	Yes	Normalized request parameters echoed by the service. Sensitive credentials are omitted when available.
`dataStatus.statusCode`	`integer`	Yes	Application-level status code returned by the API response.
`dataStatus.statusDescription`	`string`	Yes	Application-level status message returned by the API response.
`dataStatus.responseDateTime`	`string`	Yes	Response timestamp returned by the API response.
`dataStatus.dataTotalCount`	`integer`	Yes	Total number of records that match the request.
`data`	`object`	Yes	Primary response payload returned by the endpoint.
`data.wordPath`	`string`	Yes	Download URL of the generated Word document.

Response example

{
  "dataStatus": {
    "statusCode": 200,
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-17T00:00:00Z",
    "dataTotalCount": 1,
    "requestParameter": ""
  },
  "data": {
    "wordPath": "https://cdn.example.com/quarterly-report.docx"
  }
}

HTTP status codes

Use the HTTP status code for transport-level handling. If the response body contains dataStatus.statusCode, treat it as an application-level status field in the JSON payload.

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check required fields, data types, and request body format.
`401`	Missing or unknown application key.	Send a valid appkey with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Choose type=html for raw HTML and type=url when the service should fetch a webpage URL.
Validate HTML size and source URL access before sending the request.
Keep server-side retries conservative for 429, 500, and 503 responses.
Log the HTTP status code and dataStatus.statusDescription together for easier debugging.
Use the demo endpoint for a quick connectivity check, then switch to the authenticated endpoint for production data.

FAQ

Where is the official API detail page?

The official detail page is https://gugudata.io/details/html2word. It is the best place to review the latest public endpoint information before publishing or integrating.

Should I handle `dataStatus.statusCode` as the HTTP status code?

Can I use the demo endpoint in production?

No. The demo endpoint is for quick testing and examples. Use the authenticated endpoint with your appkey for production workflows.

Related GuGuData APIs

For more developer APIs, visit GuGuData.

Decode QR Code from Image API Documentation

GuGuData — Fri, 17 Apr 2026 13:52:14 +0000

Decode QR Code from Image API: Technical Guide and Integration Notes

The Decode QR Code from Image API from GuGuData helps developers decode QR code content from an uploaded image and return the parsed value, format, and detection points.

API details

Item	Value
API name	Decode QR Code from Image
Category	QR Code and Barcode APIs
Method	`POST`
Endpoint	`https://api.gugudata.io/v1/barcode/qrcode/decode`
Content type	`multipart/form-data`
Demo endpoint	https://api.gugudata.io/v1/barcode/qrcode/decode/demo
Detail page	https://gugudata.io/details/qrcode-decode

When to use this API

Decode QR values from mobile uploads, scanned images, or generated QR assets.
Build ticketing, logistics, inventory, payment, or check-in workflows.
Extract both parsed payloads and raw decoded text for downstream validation.

Request parameters

This endpoint accepts parameters through the query string plus request body. Keep appkey out of client-side public code and send it only from trusted server-side environments.

Parameter	Type	Required	Default	Description
`appkey`	`string`	Yes	`YOUR_APPKEY`	Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
`file`	`file`	Yes	-	Image file that contains a QR code.

Example request

curl -X POST "https://api.gugudata.io/v1/barcode/qrcode/decode?appkey=YOUR_APPKEY" \
  -F "file=@./qrcode.png"

Response fields

The response body contains the fields below for successful JSON responses. For binary endpoints, the success response is returned as binary content and JSON is used for error responses.

Field	Type	Required	Description
`dataStatus`	`object`	Yes	Response metadata returned by the API response.
`dataStatus.requestParameter`	`string`	Yes	Normalized request parameters echoed by the service. Sensitive credentials are omitted when available.
`dataStatus.statusCode`	`integer`	Yes	Application-level status code returned by the API response.
`dataStatus.statusDescription`	`string`	Yes	Application-level status message returned by the API response.
`dataStatus.responseDateTime`	`string`	Yes	Response timestamp returned by the API response.
`dataStatus.dataTotalCount`	`integer`	Yes	Total number of records that match the request.
`data`	`object`	Yes	Primary QR decoding result returned by the endpoint.
`data.format`	`string`	Yes	Detected code format.
`data.parsed`	`string`	Yes	Parsed QR code content.
`data.points`	`array`	No	Detected corner points of the QR code.
`data.raw`	`string`	No	Raw decoded string.
`data.type`	`string`	Yes	Detected payload type, such as `URI`, `WIFI`, `EMAIL`, or `TEXT`.

Response example

{
  "dataStatus": {
    "statusCode": 200,
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-17T00:00:00Z",
    "dataTotalCount": 1,
    "requestParameter": ""
  },
  "data": {
    "format": "QR_CODE",
    "parsed": "https://example.com",
    "points": [],
    "raw": "https://example.com",
    "type": "URI"
  }
}

HTTP status codes

Use the HTTP status code for transport-level handling. If the response body contains dataStatus.statusCode, treat it as an application-level status field in the JSON payload.

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check required fields, data types, and request body format.
`401`	Missing or unknown application key.	Send a valid appkey with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Validate file presence and supported image formats before sending the request.
Keep server-side retries conservative for 429, 500, and 503 responses.
Treat decoded content as untrusted input until your application validates the payload type and value.
Log the HTTP status code and dataStatus.statusDescription together for easier debugging.
Use the demo endpoint for a quick connectivity check, then switch to the authenticated endpoint for production data.

FAQ

Where is the official API detail page?

The official detail page is https://gugudata.io/details/qrcode-decode. It is the best place to review the latest public endpoint information before publishing or integrating.

Should I handle `dataStatus.statusCode` as the HTTP status code?

Can I use the demo endpoint in production?

No. The demo endpoint is for quick testing and examples. Use the authenticated endpoint with your appkey for production workflows.

Related GuGuData APIs

For more developer APIs, visit GuGuData.

Detect Text Language API Documentation

GuGuData — Fri, 17 Apr 2026 13:51:19 +0000

Detect Text Language API: Technical Guide and Integration Notes

The Detect Text Language API from GuGuData helps developers detect the most likely language of a text snippet and return ranked language candidates with confidence scores.

API details

Item	Value
API name	Detect Text Language
Category	Text Processing APIs
Method	`POST`
Endpoint	`https://api.gugudata.io/v1/text/detectlanguage`
Content type	`application/json`
Demo endpoint	https://api.gugudata.io/v1/text/detectlanguage/demo
Detail page	https://gugudata.io/details/nlpdetectlanguage

When to use this API

Detect the language of user-generated content before routing or moderation.
Normalize multilingual form submissions, chatbot messages, or search queries.
Add language-aware processing to content pipelines without maintaining a custom classifier.

Request parameters

This endpoint accepts parameters through the query string plus request body. Keep appkey out of client-side public code and send it only from trusted server-side environments.

Parameter	Type	Required	Default	Description
`appkey`	`string`	Yes	`YOUR_APPKEY`	Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
`content`	`string`	Yes	-	Text content to analyze.

Example request

curl -X POST "https://api.gugudata.io/v1/text/detectlanguage?appkey=YOUR_APPKEY" \
  -H "Content-Type: application/json" \
  -d '
{
  "content": "Bonjour, ceci est un exemple de texte."
}
'

Response fields

The response body contains the fields below for successful JSON responses. For binary endpoints, the success response is returned as binary content and JSON is used for error responses.

Field	Type	Required	Description
`dataStatus`	`object`	Yes	Response metadata returned by the API response.
`dataStatus.requestParameter`	`string`	Yes	Normalized request parameters echoed by the service. Sensitive credentials are omitted when available.
`dataStatus.statusCode`	`integer`	Yes	Application-level status code returned by the API response.
`dataStatus.statusDescription`	`string`	Yes	Application-level status message returned by the API response.
`dataStatus.responseDateTime`	`string`	Yes	Response timestamp returned by the API response.
`dataStatus.dataTotalCount`	`integer`	Yes	Total number of records that match the request.
`data`	`array<object>`	Yes	Ranked language detection results returned by the endpoint.
`data[].Language`	`string`	Yes	Detected language name.
`data[].LanguageAbbr`	`string`	Yes	Language code such as `en`, `fr`, or `zh`.
`data[].Probability`	`number`	Yes	Confidence score of the detected language.

Response example

{
  "dataStatus": {
    "statusCode": 200,
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-17T00:00:00Z",
    "dataTotalCount": 1,
    "requestParameter": ""
  },
  "data": [
    {
      "Language": "French",
      "LanguageAbbr": "fr",
      "Probability": 0.98
    }
  ]
}

HTTP status codes

Use the HTTP status code for transport-level handling. If the response body contains dataStatus.statusCode, treat it as an application-level status field in the JSON payload.

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check required fields, data types, and request body format.
`401`	Missing or unknown application key.	Send a valid appkey with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Validate required parameters before sending the request so 400 responses are easier to diagnose.
Keep server-side retries conservative for 429, 500, and 503 responses.
Cache stable language detection results when the same source text is processed repeatedly.
Log the HTTP status code and dataStatus.statusDescription together for easier debugging.
Use the demo endpoint for a quick connectivity check, then switch to the authenticated endpoint for production data.

FAQ

Where is the official API detail page?

The official detail page is https://gugudata.io/details/nlpdetectlanguage. It is the best place to review the latest public endpoint information before publishing or integrating.

Should I handle `dataStatus.statusCode` as the HTTP status code?

Can I use the demo endpoint in production?

No. The demo endpoint is for quick testing and examples. Use the authenticated endpoint with your appkey for production workflows.

Related GuGuData APIs

For more developer APIs, visit GuGuData.

International Phone Number Validation and Correction API Documentation

GuGuData — Fri, 10 Apr 2026 14:25:12 +0000

International Phone Number Validation and Correction API: Technical Guide and Integration Notes

The International Phone Number Validation and Correction API from GuGuData helps developers normalize and validate an international phone number using the documented formatting rules.

API details

Item	Value
API name	International Phone Number Validation and Correction
Category	Website Tools APIs
Method	`GET`
Endpoint	`https://api.gugudata.io/v1/websitetools/international-phone-format`
Content type	`query parameters`
Demo endpoint	https://api.gugudata.io/v1/websitetools/international-phone-format/demo
Detail page	https://gugudata.io/details/international-phone-format
OpenAPI JSON	https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

When to use this API

Normalize international phone numbers before storage.
Validate phone input in CRM and signup flows.
Prepare phone data for cross-region business workflows.

Request parameters

This endpoint accepts parameters through the query string. Keep appkey out of client-side public code and send it only from trusted server-side environments.

Parameter	Type	Required	Default	Description
`appkey`	`string`	Yes	`APPKEY`	Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
`phone`	`string`	Yes	`PHONE`	Phone number to normalize and validate.

Example request

curl -G "https://api.gugudata.io/v1/websitetools/international-phone-format" \
  --data-urlencode "appkey=APPKEY" \
  --data-urlencode "phone=PHONE"

Response fields

The response body contains the fields below for successful JSON responses. For binary endpoints, the success response is returned as binary content and JSON is used for error responses.

Field	Type	Required	Description
`dataStatus`	`object`	Yes	Response metadata returned by the API response.
`dataStatus.requestParameter`	`string`	Yes	Normalized request parameters echoed by the service. Sensitive credentials are omitted when available.
`dataStatus.statusCode`	`integer`	Yes	Application-level status code returned by the API response. Successful demo responses currently return `200`.
`dataStatus.status`	`string`	Yes	Application-level status enum. Successful demo responses currently return `SUCCESS`.
`dataStatus.statusDescription`	`string`	Yes	Application-level status message returned by the API response.
`dataStatus.responseDateTime`	`string`	Yes	Response timestamp returned by the API response.
`dataStatus.dataTotalCount`	`integer`	Yes	Total number of records that match the request.
`data`	`object`	Yes	Primary response payload returned by the endpoint.
`data.isValid`	`boolean`	Yes	Whether the mobile number is valid
`data.correctedMobileNumber`	`string`	Yes	Corrected mobile number
`data.countryCode`	`string`	Yes	Country phone prefix, e.g., +1
`data.countryCode2`	`string`	Yes	ISO-3166 two-letter country code
`data.countryCode3`	`string`	Yes	ISO-3166 three-letter country code

Response example

{
  "dataStatus": {
    "statusCode": 200,
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-10T00:00:00Z",
    "dataTotalCount": 1,
    "status": "SUCCESS",
    "requestParameter": ""
  },
  "data": {
    "isValid": "sample value",
    "correctedMobileNumber": "sample value",
    "countryCode": "sample value",
    "countryCode2": "sample value",
    "countryCode3": "sample value"
  }
}

HTTP status codes

Use the HTTP status code for transport-level handling. If the response body contains dataStatus.statusCode, treat it as an application-level status field in the JSON payload.

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check required fields, data types, and request body format.
`401`	Missing or unknown application key.	Send a valid appkey with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Validate required parameters before sending the request so 400 responses are easier to diagnose.
Keep server-side retries conservative for 429, 500, and 503 responses.
Cache stable metadata responses when your use case allows it, especially for lookup and directory endpoints.
Log the HTTP status code and dataStatus.statusDescription together for easier debugging.
Use the demo endpoint for a quick connectivity check, then switch to the authenticated endpoint for production data.

FAQ

Where is the official API detail page?

The official detail page is https://gugudata.io/details/international-phone-format. It is the best place to review the latest public endpoint information before publishing or integrating.

Should I handle `dataStatus.statusCode` as the HTTP status code?

Can I use the demo endpoint in production?

No. The demo endpoint is for quick testing and examples. Use the authenticated endpoint with your appkey for production workflows.

Related GuGuData APIs

For more developer APIs, visit GuGuData.

Convert Word to HTML API Documentation

GuGuData — Fri, 10 Apr 2026 14:24:20 +0000

Convert Word to HTML API: Technical Guide and Integration Notes

The Convert Word to HTML API from GuGuData helps developers convert an uploaded Microsoft Word document into HTML.

API details

Item	Value
API name	Convert Word to HTML
Category	Document and Image APIs
Method	`POST`
Endpoint	`https://api.gugudata.io/v1/imagerecognition/word-to-html`
Content type	`multipart/form-data`
Demo endpoint	https://api.gugudata.io/v1/imagerecognition/word-to-html/demo
Detail page	https://gugudata.io/details/word2html
OpenAPI JSON	https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

When to use this API

Convert Word documents into web-ready HTML.
Prepare document content for CMS ingestion.
Automate document migration into web applications.

Request parameters

This endpoint accepts parameters through the query string plus request body. Keep appkey out of client-side public code and send it only from trusted server-side environments.

Parameter	Type	Required	Default	Description
`appkey`	`string`	Yes	`YOUR_APPKEY`	Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
`file`	`file`	Yes	-	Local file uploaded as multipart form data.

Example request

curl -X POST "https://api.gugudata.io/v1/imagerecognition/word-to-html?appkey=YOUR_APPKEY" \
  -F "file=@./sample.docx"

Response fields

The response body contains the fields below for successful JSON responses. For binary endpoints, the success response is returned as binary content and JSON is used for error responses.

Field	Type	Required	Description
`html_url`	`string`	Yes	CDN URL of the converted HTML file
`html_content`	`string`	No	HTML content of the converted document (embedded content)

Response example

{
  "dataStatus": {
    "statusCode": 200,
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-10T00:00:00Z",
    "dataTotalCount": 1
  },
  "data": "sample value"
}

HTTP status codes

Use the HTTP status code for transport-level handling. If the response body contains dataStatus.statusCode, treat it as an application-level status field in the JSON payload.

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check required fields, data types, and request body format.
`401`	Missing or unknown application key.	Send a valid appkey with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Validate required parameters before sending the request so 400 responses are easier to diagnose.
Keep server-side retries conservative for 429, 500, and 503 responses.
Cache stable metadata responses when your use case allows it, especially for lookup and directory endpoints.
Log the HTTP status code and dataStatus.statusDescription together for easier debugging.
Use the demo endpoint for a quick connectivity check, then switch to the authenticated endpoint for production data.

FAQ

Where is the official API detail page?

The official detail page is https://gugudata.io/details/word2html. It is the best place to review the latest public endpoint information before publishing or integrating.

Should I handle `dataStatus.statusCode` as the HTTP status code?

Can I use the demo endpoint in production?

No. The demo endpoint is for quick testing and examples. Use the authenticated endpoint with your appkey for production workflows.

Related GuGuData APIs

For more developer APIs, visit GuGuData.

US Stock Symbols Directory API Documentation

GuGuData — Fri, 10 Apr 2026 14:23:29 +0000

US Stock Symbols Directory API: Technical Guide and Integration Notes

The US Stock Symbols Directory API from GuGuData helps developers search United States stock ticker symbols and company names with paginated results.

API details

Item	Value
API name	US Stock Symbols Directory
Category	Metadata APIs
Method	`GET`
Endpoint	`https://api.gugudata.io/v1/stock/us/symbols`
Content type	`query parameters`
Demo endpoint	https://api.gugudata.io/v1/stock/us/symbols/demo
Detail page	https://gugudata.io/details/us-stock-symbols
OpenAPI JSON	https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

When to use this API

Search United States stock symbols and company names.
Build ticker lookup in finance tools.
Normalize US market symbol metadata.

Request parameters

This endpoint accepts parameters through the query string. Keep appkey out of client-side public code and send it only from trusted server-side environments.

Parameter	Type	Required	Default	Description
`appkey`	`string`	Yes	`YOUR_APPKEY`	Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
`query`	`string`	No	-	Search keyword used for partial matching against the documented dataset fields.
`pageIndex`	`integer`	No	`1`	One-based page index for pagination.
`pageSize`	`integer`	No	`20`	Number of records returned per page.

Example request

curl -G "https://api.gugudata.io/v1/stock/us/symbols" \
  --data-urlencode "appkey=YOUR_APPKEY" \
  --data-urlencode "query=AAPL" \
  --data-urlencode "pageIndex=1" \
  --data-urlencode "pageSize=20"

Response fields

The response body contains the fields below for successful JSON responses. For binary endpoints, the success response is returned as binary content and JSON is used for error responses.

Field	Type	Required	Description
`dataStatus`	`object`	Yes	Response metadata. `dataStatus.statusCode` is a response body status field, not the HTTP status code.
`dataStatus.requestParameter`	`string`	Yes	Normalized request parameters echoed by the service. Sensitive credentials are omitted when available.
`dataStatus.statusCode`	`integer`	Yes	Response body status field. Successful demo responses currently return `100`.
`dataStatus.statusDescription`	`string`	Yes	Response body status message. Successful demo responses currently return a Chinese message.
`dataStatus.responseDateTime`	`string`	Yes	Response timestamp returned by the API response.
`dataStatus.dataTotalCount`	`integer`	Yes	Total number of records that match the request.
`data`	`array<string>`	Yes	Primary response payload returned by the endpoint.
`data[].symbol`	`string`	Yes	US stock ticker symbol
`data[].stockName`	`string`	Yes	English company name returned by the dataset.

Response example

{
  "dataStatus": {
    "statusCode": 100,
    "statusDescription": "请求成功",
    "responseDateTime": "2026-04-10T00:00:00Z",
    "dataTotalCount": 1,
    "requestParameter": ""
  },
  "data": "sample value"
}

HTTP status codes

Use the HTTP status code for transport-level handling. If the response body contains dataStatus.statusCode, treat it as an application-level status field in the JSON payload.

HTTP status	Meaning	Recommended handling
`200`	Request processed successfully.	Parse the documented response body for the endpoint result.
`400`	Invalid request parameters or request format.	Check required fields, data types, and request body format.
`401`	Missing or unknown application key.	Send a valid appkey with the request.
`403`	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
`429`	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
`500`	Internal service error.	Retry later or contact support if the error persists.
`503`	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

Validate required parameters before sending the request so 400 responses are easier to diagnose.
Keep server-side retries conservative for 429, 500, and 503 responses.
Cache stable metadata responses when your use case allows it, especially for lookup and directory endpoints.
Log the HTTP status code and dataStatus.statusDescription together for easier debugging.
Use the demo endpoint for a quick connectivity check, then switch to the authenticated endpoint for production data.

FAQ

Where is the official API detail page?

The official detail page is https://gugudata.io/details/us-stock-symbols. It is the best place to review the latest public endpoint information before publishing or integrating.

Should I handle `dataStatus.statusCode` as the HTTP status code?

Can I use the demo endpoint in production?

No. The demo endpoint is for quick testing and examples. Use the authenticated endpoint with your appkey for production workflows.

Related GuGuData APIs

For more developer APIs, visit GuGuData.

DEV Community: GuGuData

Text Processing APIs for Multilingual Developer Products

Text Processing APIs: Language Detection, Similarity, Chinese Conversion, and Metadata Lookup

API lineup

When to use these APIs

Choosing the right endpoint

Example requests

Response handling

HTTP status codes

Implementation notes

FAQ

Should I use language detection before translation?

Can text similarity replace business review rules?

Is ISBN lookup only for exact ISBN searches?

Web Content Extraction APIs for Data Pipelines

Web Content Extraction APIs: Turn URLs into Readable Data, JSON, Links, and Screenshots

API lineup

When to use these APIs

Choosing the right endpoint

Example request

Response handling

HTTP status codes

Implementation notes

FAQ

Which endpoint should I use for AI ingestion?

Should I crawl large sites directly from these endpoints?

Can I combine metadata checks with content extraction?

QR Code and Barcode APIs for Product Workflows

QR Code and Barcode APIs: Generation, Wi-Fi Access, and Image Decoding

API lineup

When to use these APIs

Choosing the right endpoint

Example requests

Response handling

HTTP status codes

Implementation notes

FAQ

Can I generate Wi-Fi QR codes with the general QR code endpoint?

Should I trust decoded QR code content automatically?

Which endpoint should I use for printed product labels?

Document Conversion APIs for Developer Workflows

Document Conversion APIs: Build Reliable HTML, PDF, Word, and PowerPoint Workflows

API lineup

When to use these APIs

Choosing the right endpoint

Integration pattern

Response handling

HTTP status codes

Implementation notes

FAQ

Should document conversion run in frontend code?

Which endpoint should I use for preview images?

Can I combine multiple APIs in one workflow?

Convert PPT to PDF API Documentation

Convert PPT to PDF API: Technical Guide and Integration Notes

API details

When to use this API

Request parameters

Example request

Response fields

Response example

HTTP status codes

Implementation notes

FAQ

Where is the official API detail page?

Should I handle dataStatus.statusCode as the HTTP status code?

Can I use the demo endpoint in production?

Related GuGuData APIs

ISBN Book Metadata Lookup API Documentation

ISBN Book Metadata Lookup API: Technical Guide and Integration Notes

API details

When to use this API

Request parameters

Example request

Response fields

Response example

HTTP status codes

Implementation notes

FAQ

Where is the official API detail page?

Should I handle `dataStatus.statusCode` as the HTTP status code?

Should I handle `dataStatus.statusCode` as the HTTP status code?

Should I handle `dataStatus.statusCode` as the HTTP status code?

Should I handle `dataStatus.statusCode` as the HTTP status code?

Should I handle `dataStatus.statusCode` as the HTTP status code?

Should I handle `dataStatus.statusCode` as the HTTP status code?