apiv1 Web Service

apiv1

Click here for a complete list of operations.

SearchLyric

Search for lyrics and return the lyricId and lyricChecksum for the GetLyric function

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /apiv1.asmx HTTP/1.1
Host: api.chartlyrics.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.chartlyrics.com/SearchLyric"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SearchLyric xmlns="http://api.chartlyrics.com/">
      <artist>string</artist>
      <song>string</song>
    </SearchLyric>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SearchLyricResponse xmlns="http://api.chartlyrics.com/">
      <SearchLyricResult>
        <SearchLyricResult>
          <TrackChecksum>string</TrackChecksum>
          <TrackId>int</TrackId>
          <LyricChecksum>string</LyricChecksum>
          <LyricId>int</LyricId>
          <SongUrl>string</SongUrl>
          <ArtistUrl>string</ArtistUrl>
          <Artist>string</Artist>
          <Song>string</Song>
          <SongRank>int</SongRank>
        </SearchLyricResult>
        <SearchLyricResult>
          <TrackChecksum>string</TrackChecksum>
          <TrackId>int</TrackId>
          <LyricChecksum>string</LyricChecksum>
          <LyricId>int</LyricId>
          <SongUrl>string</SongUrl>
          <ArtistUrl>string</ArtistUrl>
          <Artist>string</Artist>
          <Song>string</Song>
          <SongRank>int</SongRank>
        </SearchLyricResult>
      </SearchLyricResult>
    </SearchLyricResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /apiv1.asmx HTTP/1.1
Host: api.chartlyrics.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SearchLyric xmlns="http://api.chartlyrics.com/">
      <artist>string</artist>
      <song>string</song>
    </SearchLyric>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SearchLyricResponse xmlns="http://api.chartlyrics.com/">
      <SearchLyricResult>
        <SearchLyricResult>
          <TrackChecksum>string</TrackChecksum>
          <TrackId>int</TrackId>
          <LyricChecksum>string</LyricChecksum>
          <LyricId>int</LyricId>
          <SongUrl>string</SongUrl>
          <ArtistUrl>string</ArtistUrl>
          <Artist>string</Artist>
          <Song>string</Song>
          <SongRank>int</SongRank>
        </SearchLyricResult>
        <SearchLyricResult>
          <TrackChecksum>string</TrackChecksum>
          <TrackId>int</TrackId>
          <LyricChecksum>string</LyricChecksum>
          <LyricId>int</LyricId>
          <SongUrl>string</SongUrl>
          <ArtistUrl>string</ArtistUrl>
          <Artist>string</Artist>
          <Song>string</Song>
          <SongRank>int</SongRank>
        </SearchLyricResult>
      </SearchLyricResult>
    </SearchLyricResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /apiv1.asmx/SearchLyric?artist=string&song=string HTTP/1.1
Host: api.chartlyrics.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSearchLyricResult xmlns="http://api.chartlyrics.com/">
  <SearchLyricResult>
    <TrackChecksum>string</TrackChecksum>
    <TrackId>int</TrackId>
    <LyricChecksum>string</LyricChecksum>
    <LyricId>int</LyricId>
    <SongUrl>string</SongUrl>
    <ArtistUrl>string</ArtistUrl>
    <Artist>string</Artist>
    <Song>string</Song>
    <SongRank>int</SongRank>
  </SearchLyricResult>
  <SearchLyricResult>
    <TrackChecksum>string</TrackChecksum>
    <TrackId>int</TrackId>
    <LyricChecksum>string</LyricChecksum>
    <LyricId>int</LyricId>
    <SongUrl>string</SongUrl>
    <ArtistUrl>string</ArtistUrl>
    <Artist>string</Artist>
    <Song>string</Song>
    <SongRank>int</SongRank>
  </SearchLyricResult>
</ArrayOfSearchLyricResult>