Skip to main content

Request Parameters

This document outlines the required request body parameters for each MagicalAPI service.

LinkedIn Company Scraper Service

ParameterTypeRequiredDescription
company_namestringYesName of the company
company_usernamestringYesLinkedIn company username (found in company URL after /company/)
company_websitestringYesOfficial website URL of the company

LinkedIn Profile Scraper Service

ParameterTypeRequiredDescription
profile_namestringYesLinkedIn profile username (found in profile URL after /in/)

Resume Parser Service

ParameterTypeRequiredDescription
urlstringYesURL to the resume document to be parsed

Resume Checker(Review) Service

ParameterTypeRequiredDescription
urlstringYesURL to the resume document to be reviewed

Resume Matcher(Score) Service

The Resume Matcher(Score) service uses the same request parameters as the Resume Checker(Review) service.

ParameterTypeRequiredDescription
urlstringYesURL to the resume document to be scored
tip

For all document-based services (Resume Parser, Review, and Score):

  • Supported file formats include PDF, DOC, and DOCX
  • The URL must be publicly accessible
  • Maximum file size: 10MB